Syncing
Syncing is how LearnKit turns supported content in your notes into up-to-date study material.
If you create, edit, move, or delete flashcards in Markdown, run sync so LearnKit can update its internal database.
When To Sync
Section titled “When To Sync”Run sync after you:
- add new cards to notes
- edit existing flashcard content
- delete card blocks
- import large amounts of content
If you do not sync, LearnKit may still show old flashcard data or fail to show new flashcards.
How To Start A Sync
Section titled “How To Start A Sync”- Click the LearnKit sync button when available in the app UI.
- Run LearnKit: Sync cards from the command palette.
- Some edit flows, such as flashcard editing tools, may trigger sync-related updates automatically.
What Sync Actually Does
Section titled “What Sync Actually Does”- Scans supported Markdown files for LearnKit flashcard content.
- Parses fields using your current delimiter rules.
- Matches existing card blocks to stored flashcard data.
- Creates new flashcards for new blocks.
- Updates changed flashcards.
- Removes flashcards whose source blocks no longer exist.
- Maintains card anchors that connect note content to review data.
Card Anchors
Section titled “Card Anchors”After sync, LearnKit assigns an anchor like this to each tracked card block:
^learnkit-#########This anchor links the note block to its stored scheduling state.
Do not remove or edit it unless you know exactly why. If the anchor changes, LearnKit may treat the block as a different card and previous progress may no longer attach to it.
Why Cards Sometimes Do Not Appear
Section titled “Why Cards Sometimes Do Not Appear”The most common causes are:
- sync has not been run yet
- the card syntax is invalid
- the content is inside an ignored area such as fenced code blocks
- the card was quarantined because parsing failed
If a card has invalid syntax, LearnKit quarantines it instead of silently deleting it. Fix the note, then sync again.
Sync Privileges
Section titled “Sync Privileges”Sync privileges control what sync is allowed to modify in your Markdown notes. You can set this in Settings → User Details → Sync privileges.
Three levels are available:
| Level | Behaviour |
|---|---|
| Full | Rewrites flashcards into canonical format — adds anchor IDs, normalises group fields, strips hidden storage fields from IO/HQ cards, and migrates legacy shorthand. This keeps everything tidy and future-proof. |
| Simple | Only adds missing anchor IDs to flashcards that lack them, without making any other changes to your notes. |
| Off | Blocks all sync operations. You will see a notice directing you back to Settings if you try to sync. |
If you have never chosen a privilege level, the first sync attempt will show a one-time modal asking you to pick one. You can change your choice at any time.
Editing Individual Cards
Section titled “Editing Individual Cards”When you edit a flashcard through the Library, a study session, or the inline edit modal and save your changes, LearnKit automatically processes that card so your edits take effect.
To support additional fields such as extra info, titles, and groups, LearnKit always writes edited cards back in the canonical pipe-delimited format. This is required — without it the extra fields could not be saved. The rewrite affects only the card you edited.
The sync privilege you have chosen controls what else happens during the save:
| Privilege | Behaviour on card save |
|---|---|
| Full | The whole note is normalised — other cards in the same file may be updated to canonical format as well. |
| Simple | Only the card you edited is updated. Other cards in the same note are left untouched. |
| Off | Same as Simple — the edited card is saved, but nothing else in the note is changed. |
What Sync Ignores
Section titled “What Sync Ignores”- fenced code blocks by default
- non-Markdown files
Some indexing behavior can be changed in settings.
Good Habit
Section titled “Good Habit”The normal workflow is:
- write or edit notes
- run sync
- verify flashcards in Flashcard Library if needed
- start Study Sessions
Related
Section titled “Related”Last modified: 30/03/2026