0.0.5 • Published 4 years ago

anki-apkg-3 v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

anki-apkg

anki-apkg is highly inspired by anki-apkg-export and works almost the same, then why a new package?

Because I'm not satisfied with only creating {{front}} and {{back}} field for a card, this package is created to make it possible to customize fields (and any other variables of a deck or card in the future).

npm install anki-apkg
const { APKG } = require('anki-apkg')

const apkg = new APKG({
    name: 'VocabularyBuilder',
    card: {
        fields: ['word', 'meaning', 'usage'],
        template: {
            question: '{{word}}',
            answer: `
              <div class="word">{{word}}</div>
              <div class="meaning">{{meaning}}</div>
              <div class="usage">{{usage}}</div>
            `
        },
        styleText: '.card { text-align: center; }'
    }
})
apkg.addCard({
    timestamp: +new Date(), // create time
    content: ['sample word', 'sample meaning', 'sample usage'] // keep the order same as `fields` defined above
})
apkg.save(__dirname)

Media

You can add media files to packages using

apkg.addMedia(filename: string, data: Buffer)
const { readFileSync } = require('fs')
const { join } = require('path')

const { APKG } = require('../')

const apkg = new APKG({
    name: 'UnicornBuilder',
    card: {
        fields: ['question', 'result'],
        template: {
            question: '{{question}}',
            answer: `{{result}}`
        }
    }
})
apkg.addCard({
    content: ['What happens if you eat too many skittles?', '<img src="unicorn.gif" />']
})
apkg.addMedia('unicorn.gif', readFileSync(join(__dirname, 'media/unicorn.gif')))
apkg.save(__dirname)
0.0.5

4 years ago