Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yuukanoo/obsidian-flashcards

Export your obsidian notes to Anki.
https://github.com/yuukanoo/obsidian-flashcards

anki anki-flashcards obsidian

Last synced: about 4 hours ago
JSON representation

Export your obsidian notes to Anki.

Host: GitHub
URL: https://github.com/yuukanoo/obsidian-flashcards
Owner: YuukanOO
License: agpl-3.0
Created: 2025-01-17T09:12:03.000Z (7 days ago)
Default Branch: master
Last Pushed: 2025-01-23T14:17:00.000Z (about 17 hours ago)
Last Synced: 2025-01-23T15:23:14.052Z (about 16 hours ago)
Topics: anki, anki-flashcards, obsidian
Language: TypeScript
Homepage:
Size: 58.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# obsidian-flashcards

Export your obsidian notes to Anki.

> [!WARNING]
> This is currently a work in progress. It covers my needs and I already use it but it has several [limitations](#limitations).

## Motivation

There are many plugins about exporting your Obsidian notes to [Anki](https://apps.ankiweb.net/) flash cards but none suited my needs so I've decided to create this plugin to match my way of thinking.

## Prerequisite

- [Anki Desktop](https://apps.ankiweb.net/)
- [AnkiConnect](https://ankiweb.net/shared/info/2055492159)

The first time you'll try to export your notes, Anki will ask you to allow Obsidian to manage your notes. Allow it or this plugin will not be able to create decks and manage their notes.

## Expected format

Write your documents as usual. When you need to include some cards, just add a specific section. By default, the plugin search for a line starting with `#cards` followed by a new line and everything below it will be parsed as notes (with front, back and individual notes separated by `---`) but you can update it to suit your needs.

Currently, it only supports the "Basic" card format. Let's say you got this document in `/Some/Subject`:

```md
# Some subject here

Some content about the subject.

#cards

A first question?

---

And a first answer!

---

A second question?

---

And a second answer!
```

When running the **Export notes to Anki** command (using the **Obsidian command palette**), this plugin will create a deck named **Some** if it doesn't exist yet and create 2 cards matching the following JSON:

```json
[
{
"id": 1, // Determined by Anki
"front": "A first question?",
"back": "And a first answer!",
"tags": ["Some", "Subject", "obsidian:some-subject"]
},
{
"id": 2,
"front": "A second question?",
"back": "And a second answer!",
"tags": ["Some", "Subject", "obsidian:some-subject"]
}
]
```

To keep track of existing notes, this plugin will update your Obsidian notes to include the note id. For example, the original document will be updated as follow: