anki-apkg-export


Universal module for generating decks for Anki.

Port of the Ruby gem https://github.com/albertzak/anki2

Install

``
$ npm install anki-apkg-export --save
`

Usage

$3

`js
const fs = require('fs');
const AnkiExport = require('anki-apkg-export').default;

const apkg = new AnkiExport('deck-name');

apkg.addMedia('anki.png', fs.readFileSync('anki.png'));

apkg.addCard(['card #1 front', 'card #1 back']);
apkg.addCard(['card #2 front', 'card #2 back'], { tags: ['nice', 'better card'] });
apkg.addCard(['card #3 with image ', 'card #3 back']);

apkg
.save()
.then(zip => {
fs.writeFileSync('./output.apkg', zip, 'binary');
console.log(Package has been generated: output.pkg);
})
.catch(err => console.log(err.stack || err));
`

$3

Intended to be used with webpack

`js
const webpack = require('webpack');

module.exports = {
entry: './index.js',
module: {
loaders: [
{
test: /\.js$/,
exclude: /node_modules/,
loader: 'babel'
},
]
},
plugins: [
new webpack.DefinePlugin({
'process.env': {
NODE_ENV: JSON.stringify(process.env.NODE_ENV || 'development')
},
})
],
output: {
path: __dirname,
filename: 'bundle.js'
}
};
`

Required loaders:

- script-loader

`js
import { saveAs } from 'file-saver';
import AnkiExport from 'anki-apkg-export';

const apkg = new AnkiExport('deck-name');

// could be a File from or a Blob from fetch
// take a look at the example folder for a complete overview
apkg.addMedia('anki.png', file);

apkg.addCard(['card #1 front', 'card #1 back']);
apkg.addCard(['card #2 front', 'card #2 back'], { tags: ['nice', 'better card'] });
apkg.addCard(['card #3 with image ', 'card #3 back']);

apkg
.save()
.then(zip => {
saveAs(zip, 'output.apkg');
})
.catch(err => console.log(err.stack || err));
`

Examples

- server from above
- browser from above
- browser usage with media attachments via ajax
- browser usage with media attachments via