Anki add-on for syncing with Obsidian. Please read the limitations section before use.
The goal of this add-on is to provide an integration between Anki and Obsidian, with the main feature being bidirectional note syncing between the two apps.
The add-on focuses on notes rather than cards. This means that there is no deck information ported from Anki to Obsidian as that is a card concept and a given note's cards may reside in different decks.
The app syncs Anki note models to Obsidian's templates folder, allowing the user to create new notes in Obsidian using the templates core plugin. If the core plugin is disabled, the Anki models will not be synced. See the limitations section for further details.
If a given note has been modified in both apps, Anki takes precedence. This is because the add-on uses last-modified timestamp for Obsidian files to determine if a note has been recently modified. If iCloud is used to sync Obsidian files, then off-loading and re-downloading iCloud files updates their last-modified timestamps. This makes them appear to be recently modified even if that's not the case.
The add-on treats spaced repetition system (SRS) notes (i.e. Anki notes) as first-class citizens and creates one Obsidian note per SRS note in Anki. That said SRS notes can coexist with regular notes in Obsidian, so it's possible to have one regular Obsidian note on a given topic, populated with links to SRS note sections that contain parts of the theory relating to the concept. As long as the regular note is not created from an SRS note template, then the add-on will not try to sync it to Anki.
- All default Anki note types.
- Option to add Obsidian URI field to the Back Template of every Anki card to allow opening the Obsidian note (works on mobile too).
- Links to other notes in Obsidian files are translated to Obsidian URIs when synced to Anki.
- The set of embedded media (image, audio, video) files officially supported by Obsidian.
- See this page for the file formats supported by Obsidian.
- See the limitations section for details on how media files are handled.
- The files are duplicated on both platforms so that they are accessible on mobile as well.
- LaTex, both in-line and blocks.
- Code, both in-line and blocks.
- Syncing Anki "suspended" status on a per-note basis.
- If all cards associated with the note are suspended in Anki, this property will be checked in Obsidian, otherwise it will be unchecked.
- If a note is "suspended" (i.e. all its cards are suspended in Anki) and the property is unchecked in Obsidian, this will cause all associated Anki cards to be unsuspended.
- If a note is not "suspended" (i.e. at least one of its cards is not suspended in Anki) and the property is checked in Obsidian, this will cause the associated Anki cards to be suspended.
- SRS notes can coexist with regular Obsidian notes in the Obsidian vault.
| Config | Description |
|---|---|
vault-path |
Path to Obsidian vault. |
srs-folder-in-obsidian |
Set a specific folder path relative to the Obsidian vault to use for SRS notes. |
sync-with-obsidian-on-anki-web-sync |
If enabled, Anki will sync with Obsidian before every sync with Anki web. |
anki-deck-name-for-obsidian-imports |
The name of the Anki deck in which the cards of notes imported from Obsidian will default to. |
add-obsidian-url-in-anki |
Adds an extra field to all note models in Anki that will contain the Obsidian URI associate with the note to allow quickly jumping to the note in the Obsidian app. |
| Shortcut | Description |
|---|---|
Ctrl + Y |
Sync with Obsidian |
This add-on will likely re-format your Anki and/or Obsidian notes in order to ensure that a given note can be converted to HTML or Markdown and back to the original text in the original format. The content of the notes will not be changed by this process. However, be sure to back up your Anki files and your Obsidian vault before use.
Currently, all attachment files imported from Anki to Obsidian are copied to a dedicated folder called srs-attachments
placed under the designated folder used for Anki cards (see the configs section to learn about setting the
designated folder).
Anki note models are synced uni-directionally with Anki being the ground truth. This means that any modifications to the models must happen in Anki and then be synced to the Obsidian templates.
The addon will convert markdown links of the form [alt text](path/to/obsidian note.md) to HTML links with
Obsidian URIs. However, WikiLinks
are not currently supported. The add-on will treat them as regular text.
Moving or renaming a note in Obsidian on Windows without changing its content won't update the note's URI in Anki.
- Handle Wikilinks links