README file from
GithubEasy Recall
English | 中文
A minimalist spaced repetition plugin focused on core memorization features—zero configuration, just write and review.
Features
- Zero Configuration - Start reviewing immediately after installation, no complex setup needed
- Native Markdown Syntax - Create cards with
==highlight==and?questionsyntax, supports full-width question mark? - File-level Tags - Define decks with
#easy-recall/xxx, supports Chinese tags - Three-state Rating - Again/Hard/Good, simplify decision fatigue
- Instant Feedback - "Again" cards go back to queue tail immediately, continue reviewing in current session
- Multi-language Support - Auto-adapts to Obsidian language settings (English/Chinese)
- SuggestModal Deck Selector - Quick Switcher-like deck selection experience
- Review Surface Option - Review in the default modal window or reuse an Obsidian tab
- Mobile Support - Perfectly adapted for phones and tablets
Installation
Manual Installation
- Download the latest version of
main.js,manifest.json,styles.css - Create
.obsidian/plugins/easy-recall/directory in your Obsidian Vault - Copy the downloaded files to that directory
- Enable the plugin in Obsidian settings
From Community Plugin Marketplace
Easy Recall has been submitted to the Obsidian Community Plugin Marketplace. After approval, install it from Obsidian settings under Community plugins.
Usage
Creating Cards
Rule: Cards must be separated by blank lines. A card = a continuous non-empty text block.
Cloze Cards
Traditional Chinese Medicine studies ==human life movement==.
Multi-line Cloze Cards Adjacent Cloze lines in the same block are merged into one card:
Applications:
1. Cold: ==induce sweating==
2. Cough: ==relieve asthma==
To create separate cards, use blank lines:
1. Cold: ==induce sweating==
2. Cough: ==relieve asthma==
Q&A Cards
What is 2+2?
4
Or:
What is the area formula for a circle?
?
S = πr²
Cards with Hint (Optional)
What is the formula for the area of a circle?
?
S = πr²
> [!hint] Think about the relationship between radius and area
> π is approximately 3.14159...
💡 Supports full-width question mark
?, suitable for Chinese input habits💡 Hint uses Obsidian callout syntax
> [!hint], displayed optionally during review
Defining Decks
Add tags at the beginning of the file:
---
tags:
- easy-recall/math
---
Card content...
Or in the body:
#easy-recall/math
Card content...
Start Reviewing
- Click the review icon 📚 in the left sidebar, or use command palette to execute "Start Review"
- Search and select a deck in SuggestModal, or press Enter to review all due cards
- View the card, press Space on desktop to reveal the hint or answer, or click/tap "Show Hint" / "Show Answer"
- Select rating:
- 1 - Again (🔴): Put back to queue tail immediately, continue reviewing in current session
- 2 - Hard (🟠): Interval ×1.2, ease -15
- 3 - Good (🔵): Standard interval, ease unchanged
You can also run "Review Due Cards in Current Note" from the command palette in any Markdown note to review only due cards from that note.
By default, each review session includes up to 20 due cards, so cards marked Again can return quickly within the same smaller batch. Change Review Batch Size in plugin settings to adjust this limit. If more due cards remain after the batch is finished, the completion screen offers Continue Review to start the next batch.
By default, reviews open in a modal window. In plugin settings, configure Desktop Review Interface and Mobile Review Interface separately to use either a modal window or a reusable Obsidian tab on each platform.
The default deck tag prefix is easy-recall. Change Deck Tag Prefix in plugin settings if you want a different prefix.
To hide a specific heading from the review path, add <!--easy-recall-hide--> at the end of that heading line:
# Chapter <!--easy-recall-hide-->
## Section
==Answer== content
The review path will show File name / [...] / Section. This only masks the marked heading segment; the file name and unmarked child headings still appear.
Desktop Shortcuts
Desktop shortcuts work in both the modal window and the reusable Obsidian tab. Space only reveals content; ratings are handled by number keys after the answer is visible.
| Key | Function |
|---|---|
| Space | Show hint, then show answer |
| 1 | Again |
| 2 | Hard |
| 3 | Good |
Data Storage
Review data is stored as HTML comments before the card:
<!--SR:1,250,2026-02-18T10:00:00Z,1-->
Traditional Chinese Medicine studies ==human life movement==.
Format: <!--SR:interval,ease,due,reps-->
Your notes always belong to you, data does not depend on any external service.
Algorithm
Simplified SM-2 algorithm:
- Interval Days: Dynamically calculated based on rating, maximum 365 days
- Ease: 130-350 range, affects interval growth speed
- Consecutive Success Count: Affects when new cards enter formal review
Development
# Install dependencies
npm install
# Development mode (auto rebuild)
npm run dev
# Build production version
npm run build
# Run tests
npm test
# Test coverage
npm run test:coverage
For repository conventions and implementation boundaries, see AGENTS.md.
License
MIT License - See LICENSE file
Acknowledgements
- Inspired by Anki and Obsidian Spaced Repetition plugin
- Follows Obsidian official plugin development best practices
Made with ❤️ for Obsidian users