genanki-js
v2.0.0
Published
A JavaScript implementation for generating Anki decks in browser client side
Downloads
17
Readme
genanki-js
A JavaScript implementation for generating Anki decks in browser. This is fork of mkanki.
QuickStart
npm i genanki-js
View sample project to get started
Documentation
View Documentation
CSV/TSV to Anki Package
Visit page and select CSV to APKG
from top menu.
CSV to APKG
Set-up a project from scratch
- Install genanki-js
npm i genanki-js
- Create a
SQL
global variable (may be added to index.js). Sql setup may be different for different JS library. View for react sql-js/react-sqljs-demo and read more at sql.js.org
// The `initSqlJs` function is globally provided by all of the main dist files if loaded in the browser.
// We must specify this locateFile function if we are loading a wasm file from anywhere other than the current html page's folder.
config = {
locateFile: filename => `js/sql/sql-wasm.wasm`
}
let SQL;
initSqlJs(config).then(function (sql) {
//Create the database
SQL = sql;
});
- Now use following
Examples
to generate and export decks.
View more examples here Examples
Examples
var m = new Model({
name: "Basic (and reversed card)",
id: "1543634829843",
flds: [
{ name: "Front" },
{ name: "Back" }
],
req: [
[ 0, "all", [ 0 ] ],
[ 1, "all", [ 1 ] ]
],
tmpls: [
{
name: "Card 1",
qfmt: "{{Front}}",
afmt: "{{FrontSide}}\n\n<hr id=answer>\n\n{{Back}}",
},
{
name: "Card 2",
qfmt: "{{Back}}",
afmt: "{{FrontSide}}\n\n<hr id=answer>\n\n{{Front}}",
}
],
})
var d = new Deck(1276438724672, "Test Deck")
d.addNote(m.note(['this is front', 'this is back']))
var p = new Package()
p.setSqlJs(SQL); // global SQL variable from step 2 in setup
p.addDeck(d)
p.writeToFile('deck.apkg')
License
genanki-js
GNU Affero General Public License v3 Copyright (c) 2021 Mani