` of each card by Yanki.\n\nThe classes include:\n\n- `yanki`: Shared by all cards generated by Yanki\n- `namespace-$name`: The namespace associated with the card\n- `front` | `back`: The \"side\" of the card\"\n- `model-$name`: The name of the card type / model, one of the following. They're wordy, but consistent with Anki's default model naming scheme:\n - `model-yanki-basic`\n - `model-yanki-basic-and-reversed-card`\n - `model-yanki-basic-type-in-the-answer`\n - `model-yanki-cloze`\n\nFor example, the front of a basic card would look like:\n\n```html\n
\n \n
\n```\n\n### Browser environments\n\nThe Yanki TypeScript / JavaScript library is isomorphic, so you can run it in a browser you'd like.\n\nThere's one exception, the `syncFiles(...)` function, which by default relies on file system access to work.\n\nTo retain `syncFiles(...)`'s utility in a browser environment, it accepts an optional `fileAdapter` argument providing implementations of `readFile`, `readFileBuffer`, `rename`, `stat`, and `writeFile`, which are implemented via `node:fs/promises` by default in Node environments.\n\nRunning Yanki in a browser environment requires implementing and passing a `fileAdapter` with these five functions to `syncFiles(...)`, suited to your particular use case. (A warning will be provided if you neglect to do so.)\n\nThe rest of the library should work fine in both contexts without special measures.\n\n## Background\n\n### Implementation notes\n\nThe excellent [unified](https://unifiedjs.com) / [remark](https://remark.js.org) / [rehype](https://github.com/rehypejs/rehype) libraries are used extensively to traverse and render the underlying Markdown ASTs.\n\n[AnkiConnect](https://ankiweb.net/shared/info/2055492159) provides access to Anki's database.\n\nFor type safety, access to AnkiConnect is managed through my wrapper library, [yanki-connect](https://github.com/kitschpatrol/yanki-connect).\n\nBehind the scenes, Yanki creates new note type models to match the four default Anki types. It keeps track of the notes it has ownership of via a hidden `YankiNamespace` field in each note.\n\nLinux testing was performed with Debian 12 and Ubuntu 22, both running on an arm64 virtual machine. Anki does not officially support arm64 Linux, but a [workaround](https://github.com/ankitects/anki/issues/2302#issuecomment-1374374155) was able to get Anki up and running.\n\n### Other projects\n\n- Luke Murray's [markdown-anki-decks](https://github.com/lukesmurray/markdown-anki-decks)\n- Oleksandr Shlinchak's [mdanki](https://github.com/ashlinchak/mdanki).\n- Ben Weinstein-Raun's [ankidown](https://github.com/ankicommunity/ankidown/)\n- Alex Biosa's [Markdown2Anki](https://github.com/Mochitto/Markdown2Anki)\n- Pradhyo Bijja's [anki-markdown-notes](https://github.com/Pradhyo/anki-markdown-notes)\n- Langfield's [ki](https://langfield.github.io/ki/)\n\n## Known issues\n\n- Intra-note links _do not update_ after automatic renaming, e.g. via the `--manage-filenames` flag, potentially resulting in broken links.\n\n- Removing one or more clozes from a note with multiple clozes can result in empty cards after syncing. The only way around this is to run the \"Tools → Empty Cards...\" command from Anki desktop application menu bar.\n\n- The Anki application lets you split the cards from a single note across multiple decks. (E.g. you might have a card with dozens of clozes, some of which you want to study under a different deck.) Yanki does _not_ support this scenario in the notes / cards it manages — it maintains a strict hierarchical relationship in which a note and its cards always live in a single deck. Notes may be deleted / recreated and study progress might be lost if this is attempted.\n\n- Anki does not let you use cloze syntax in note types that aren't explicitly configured to handle them. For this reason, don't [mix and match native Anki syntax](https://github.com/kitschpatrol/yanki/issues/18) alongside Yanki's Markdown syntax. If you do this, you risk receiving cryptic \"cannot create note for unknown reason\" errors from AnkiConnect.\n\n## Maintainers\n\n[kitschpatrol](https://github.com/kitschpatrol)\n\n## Acknowledgments\n\nThanks to Alex Yatskov for creating [AnkiConnect](https://ankiweb.net/shared/info/2055492159).\n\nThanks to the [unified team](https://github.com/orgs/unifiedjs/people) for their superb ecosystem of AST tools.\n\n\n\n## Contributing\n\n[Issues](https://github.com/kitschpatrol/yanki/issues) are welcome and appreciated.\n\nPlease open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.\n\nThis repository uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) (via its `ksc` CLI) for linting and formatting, plus [MDAT](https://github.com/kitschpatrol/mdat) for readme placeholder expansion.\n\n\n\n\n\n## License\n\n[MIT](license.txt) © [Eric Mika](https://ericmika.com)\n\n\n","readmeFilename":""}