For the directly usable version, please download it from the here.
For suggestions and feedback, please submit them here.
| Template | Description | Links |
|---|---|---|
| mcq | Multiple choice question (6 options) | Preview Docs |
| mcq_10 | Multiple choice question (10 options) | Preview Docs |
| mcq_26 | Multiple choice question (26 options) | Preview Docs |
| match | Drag and drop interactive matching | Preview Docs |
| tf | True or false | Preview Docs |
| basic | Basic Q&A | Preview Docs |
| cloze | Cloze template | Preview Docs |
| input | Type in answer | Preview Docs |
All of the templates have the following common features:
- Markdown support: see here for details
- After selecting text, you can directly click to ask gpt, search or translate the corresponding text, and customization is also supported
- Support larger question text.
- Support dark mode and light mode.
- Countdown: Give you motivation to learn.
This project welcomes any form of open-source contribution. Here is some information to help you get started quickly.
This project uses node's type stripping feature, so you need to install node version 23.6.0 or above.
After installation, run the following commands to install project dependencies.
corepack enable
pnpm install
This project provides specific development commands. For example, to develop the mcq template, run:
pnpm dev mcq
Then visit http://localhost:3000, by default you will see the mcq.en.native template.
You can also specify the development language and field type through parameters:
pnpm dev mcq --locale=zh --field=markdown
To flip the card during development, execute the following in the browser console:
setBack(true)
Generating an Anki apkg format package requires two steps:
- Build: Run
pnpm buildto build all templates. You can also pass parameters similar to the development command to specify the build. Omitting an option means all possible values for that option will be built.
pnpm build --entry=mcq --locale=en --field=native
- Package:
pnpm package
The Apkg file will be located in the release directory.
If your PR modifies the templates, please run pnpm changeset. This will ask for a description of your changes. Please fill it out according to Conventional Commits. Be sure to include the generated Markdown file in the PR.