Home

Welcome to the flashcards-obsidian wiki!

Since you have found your way here, I suppose you already have installed the plugin and now want to learn more about how it works. If this shouldn't be the case, take a look at the installation section in the repo's README.md.

Note

If you don't understand some of the stuff I'm writing here or maybe have a better way to put it into words, please feel free to open an issue! :)

Card Syntax

Have a look at the Parsing section of this wiki to learn more about which text is detected as flashcard.

Generating Cards

Essentially, there two ways to generate new or update existing flashcards from Obsidian:

1. Open the command palette with either Ctrl+P or Cmd+P and type in "Generate from current file"

Tip

If this is something you can imaging doing regularly, you can pin the command by navigating to the Settings > Command palette and adding it there

2. Right-click on the file or folder (of which all files in all sub-folders) you want to process and select "Generate flashcards"

After the processing is done, you should get a informative notification toast with stats about the processed cards and a tags with the Anki note IDs of your just generated cards should appear below the respective card's content. They are for tracking the note on future syncs and use Obsidian's block link syntax with a 13 digit id (^1234567890123) which makes them invisible when the Obsidian note is previewed. It can be used to inspect the card by searching nid:1234567890123 in the Anki Browser.

Diffs

If you did some changes to your note and are not sure yet if you like them in Anki, you have the options to generate diffs (differences) between the Anki card and your Obsidian card sections.

The ways to trigger them are the same as for the normal card generation, but are suffixed or substituted with "diff". When typing in "diff" in the command palette, the command should appear.

Troubleshooting

If the processed content looks off to you, please create an issue. The processing logic of this plugin got fairly complex, so bugs are possible and to be expected.

If you feel adventurous, you could have a look at the debugging messages in Obsidian's console (Ctrl+Shift+i > all levels in the to right) & the code to maybe figure out the issue on your own.

Features

The granularity of the card detection allow for multiple cards per note, which again allows really granular processing options for them. They are documented in the Feature section of this wiki.

Customization

The anki-card.css file in your plugin folder can be used to include any CSS styles into the Anki card models. To sync the models, just run the Update Anki note models command in the command palette. It would be really nice to have a list of cool Anki flashcard style recipes in here! :)

The templates used for the Anki notes can be found in the constants.ts file.

The udpate model command also adds the scripts from the scirpts/ folder into the Anki card HTML. Such a script is currently used to display the Anki tags in a fun way.