ankify 0.1.1

Generate and sync Anki flashcards from your Typst documents.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

<br>
<div align="center">
<picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nvlang/ankify/main/res/dark/logotype.svg">
    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/nvlang/ankify/main/res/light/logotype.svg">
    <img alt="Ankify Logotype" src="https://raw.githubusercontent.com/nvlang/ankify/main/res/light/logotype.svg" width="33%">
</picture>
<br>
<br>
<div>

[<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/ankify-_?style=flat-square&logo=typst&logoColor=a3acb7&labelColor=21262d&color=21262d&logoSize=auto"><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/ankify-_?style=flat-square&logo=typst&logoColor=24292f&labelColor=eaeef2&color=eaeef2&logoSize=auto"><img alt="Typst package name" src="https://img.shields.io/badge/ankify-_?style=flat-square&logo=typst&logoColor=24292f&labelColor=eaeef2&color=eaeef2&logoSize=auto"></picture>](https://typst.app/universe/package/ankify)
[<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/crates/ankify-_?style=flat-square&logo=rust&logoColor=a3acb7&labelColor=21262d&color=21262d&logoSize=auto"><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/crates/ankify-_?style=flat-square&logo=rust&logoColor=24292f&labelColor=eaeef2&color=eaeef2&logoSize=auto"><img alt="Rust crate name" src="https://img.shields.io/badge/crates/ankify-_?style=flat-square&logo=rust&logoColor=24292f&labelColor=eaeef2&color=eaeef2&logoSize=auto"></picture>](https://crates.io/crates/ankify)
</div>
</div>
<br>

> [!WARNING]
> `ankify` is alpha software under active development. Expect bugs, rough edges,
> and breaking changes between releases.

`ankify` is the command-line tool — and library — at the heart of
[Ankify](https://github.com/nvlang/ankify). It reads a Typst document that uses
the [`ankify` Typst package](https://typst.app/universe/package/ankify), renders
each flashcard, and syncs it to Anki through the
[AnkiConnect](https://foosoft.net/projects/anki-connect/) add-on — adding new
cards, updating changed ones, and leaving the rest untouched.

## Installation

```sh
cargo install ankify
```

To run it you also need:

- the [Typst](https://typst.app) CLI (`typst`) on your `PATH`;
- [Anki](https://apps.ankiweb.net), running, with the **AnkiConnect** add-on;
- the [`ankify` Typst package](https://typst.app/universe/package/ankify) — your
  documents import it to mark up cards.

## Usage

```sh
ankify notes.typ
```

```
ankify <FILE> [options]

  -v, --verbose                Verbose output
      --cache-file <PATH>      Custom cache file location
      --ankiconnect-url <URL>  AnkiConnect URL (default: http://127.0.0.1:8765)
      --root <DIR>             Typst project root
      --font-path <PATH>       Additional font path (repeatable)
```

Re-running `ankify` on the same file is incremental: a cache
(`.ankify/cache.json`, next to the document) records what was synced, so only
new or changed notes are sent to Anki.

The [project README](https://github.com/nvlang/ankify) covers the end-to-end
workflow — writing notes, the helper-function pattern, and theme-aware cards.

## Library

The same crate is also a library, should you want to drive a sync
programmatically:

```sh
cargo add ankify
```

```rust
use ankify::sync::{sync, SyncConfig};

let result = sync(SyncConfig::new("notes.typ")).await?;
println!("{} added, {} updated", result.notes_added, result.notes_updated);
```

API documentation is published on [docs.rs](https://docs.rs/ankify).

## License

MIT — see [LICENSE](LICENSE).

## Trademarks

Anki is a trademark of Ankitects Pty Ltd. `ankify` is an independent project,
not affiliated with, endorsed by, or sponsored by Ankitects Pty Ltd.