Skip to content

shbernal/ankimd

Repository files navigation

ankimd

CI core weekly downloads core total downloads cli weekly downloads cli total downloads

Convert Anki exports into readable Markdown flashcards. This repository hosts the CLI plus the shared package that powers the conversion pipeline.

Project layout

  • cli/: The published CLI (@shbernal/ankimd-cli)
  • packages/: Shared library code used by the CLI
  • scripts/, turbo.json, pnpm-workspace.yaml: Repo-level tooling

Requirements

  • Node.js >= 20

Install (CLI)

pnpm i -g @shbernal/ankimd-cli

Install (library)

pnpm add @shbernal/ankimd

Local repo workflows

  • Run the local-dev CLI against repo sources from the project root:
    • pnpm ankimd-local -- --help
    • pnpm ankimd-local -- convert test/input/english-vocabulary-anki-flashcards-export.txt
  • Run the pack/install smoke test from the project root:
    • pnpm cli-local-test
  • Run the fixture-backed test suite from the project root:
    • pnpm test
  • pnpm cli-local-test defaults to writing tarballs under .tmp/packed/.
  • Override the pack output directory when needed:
    • ANKIMD_PACK_DIR=/tmp/ankimd-packed pnpm cli-local-test

Status

  • Flashcards .txt export conversion is implemented.
  • .apkg support is still a later phase.

About

Convert Anki exports into readable Markdown flashcards.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors