README.md

joplin-anki-sync

Automated management of Anki flashcards based on Joplin notes for effective spaced repetition learning.

Requirements

• Joplin Web clipper service
• Anki AnkiConnect add-on

Configuration

• Clone https://github.com/abletsoff/joplin-anki-sync
• Create and copy Joplin Web Clipper authorization token

• Create token.json file in the joplin-anki-sync directory with the following content:

{
        "token":"paste_your_authorization_token_here"
}

• Adjust config.json file for your personal setup

Demo

Script execution

Anki card browse

Joplin note

joplin-anki-sync algorithm

• Goes through Joplin folders (specified in config.json)
• Separate each Joplin topic at markdown Heading Level 1 (e.g. # Topic 1)
• Generate Anki flashcard based on the Joplin topic. Flashcard front: Joplin note name + # Topic 1; flashcard back: hash of the Joplin topic content. For the reasons of using hash as back of flashcard see Issue 2
• Check if there is an Anki flashcard with the same front
  • There is no flashcard with the same front: create new flashcard in Anki deck
  • There is flashcard with the same front, back hash is the same: do nothing
  • There is flashcard with the same front, back hash is not the same: remove old flashcard & create new one