Anki Embed

by devsdocs
5
4
3
2
1
Score: 35/100

Description

Reviews

No reviews yet.

Stats

0
stars
87
downloads
0
forks
28
days
6
days
9
days
1
total PRs
1
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
43
commits

Latest Version

9 days ago

Changelog

What's Changed in 1.0.19

  • Reset View & Return to Deck Selection: Added controls to reset the review session and return directly to the interactive deck picker from anywhere:
    • In-Review Controls: Added \↩ Deck selection\ in the header actions and a \↩ Back to deck selection\ link in the active card review footer.
    • Screen Navigation: Added \↩ Back to deck selection\ secondary buttons to the start screen, session complete summary, and empty state.
    • Full Editor View & Commands: Added \Back to deck selection\ action to \AnkiView\ and a command \Reset Anki view to deck selection.
  • State Reset: Cleanly resets session progress and active deck selection when navigating back to deck selection.

Compatibility

  • Requires Obsidian 1.13.0+

README file from

Github

Obsidian Anki Embed

An Obsidian plugin that embeds interactive Anki flashcard decks directly into your notes using AnkiConnect.

Features

  • Full Editor View & Note Embeds: Review flashcard decks directly in full workspace editor tabs (ItemView) or embedded inside notes. Seamlessly switch from in-note embeds to full view with the Full view header action.
  • Interactive Flashcard Player: Review flashcards with flip animations, rating buttons (Again, Hard, Good, Easy), and session summary statistics breakdown.
  • Interactive Deck Picker with Live Search: Choose decks dynamically via an inline picker (select: true) or switch decks on the fly using the 📚 Change deck header action.
  • Ribbon Action: Click the left sidebar ribbon icon to open Anki review in a full editor view or insert a deck into your active note.
  • Full AnkiConnect API Coverage: Strongly-typed wrappers for all 40+ AnkiConnect endpoints (Decks, Cards, Notes, Models, Media, GUI, Stats, and Sync).
  • AnkiConnect Integration: Connects locally to Anki via http://127.0.0.1:8765.
  • Card Rating & Sync: Rate cards and sync review status directly to Anki.
  • Flexible Code Block Syntax:
    • Embedded specific deck:
      deck: Japanese::Kanji
      limit: 20
      filter: due
      randomize: true
      
    • Simple single-line deck embed:
      Medical::Pharmacology
      
    • Interactive deck picker:
      select: true
      
      or
      deck: ?
      
    • Custom search queries:
      query: deck:"Default" is:due tag:vocab
      
  • Pasted Anki URI Auto-Conversion: Pasting anki://deck/... or anki:... links automatically converts them into an ````anki code block.
  • Command Palette Tools:
    • Open Anki review in full view: Opens interactive Anki review directly in a full workspace tab.
    • Open Anki deck in full view: Fuzzy search and open any Anki deck in a full workspace tab.
    • Insert Anki deck embed: Fuzzy pick an Anki deck and insert code block into active editor.
    • Insert interactive Anki deck picker: Inserts select: true interactive picker block.
    • Import Anki notes from CSV/TSV: Opens a step-by-step modal to paste and map CSV/TSV data directly into an Anki deck.
    • Sync Anki collection: Synchronize your Anki collection directly from Obsidian.
    • Test AnkiConnect connection: Instant connectivity check with Notice feedback.
  • Keyboard Shortcuts:
    • Space / Enter: Reveal card answer.
    • 1, 2, 3, 4: Rate card (1: Again, 2: Hard, 3: Good, 4: Easy).
    • R: Refresh deck session.

Prerequisites

  1. Use Obsidian 1.13.0 or newer.
  2. Install Anki.
  3. Install the AnkiConnect add-on in Anki (Add-on code: 2055492159).
  4. Make sure Anki is open while reviewing notes in Obsidian.

[!TIP] Want to use this plugin on Obsidian Mobile or without ever keeping Anki open on your computer? You can host anki-docker-server on a remote VPS. Just point this plugin's AnkiConnect URL setting to your server's IP to unlock full headless and mobile capabilities!

Installation

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Place them in your vault's .obsidian/plugins/anki-embed/ folder.
  3. Enable Anki Embed in Obsidian settings.

Known Limitations & Custom Fork Solution

  • Review Time Statistics: Due to limitations in the official AnkiConnect API, it cannot record the actual time you spent reviewing a card (it logs as 0 seconds).
    • The Solution: We provide a heavily modified Custom AnkiConnect Fork that adds time-tracking capabilities. If you install this custom .ankiaddon package instead of the official one, simply enable "Use custom AnkiConnect" in your Obsidian settings to unlock perfectly accurate review time statistics!

License

MIT