https://github.com/railly/obsidian-simple-flashcards
Display interactive flashcards to formulate knowledge
https://github.com/railly/obsidian-simple-flashcards
flashcards learning memory obsidian obsidian-md obsidian-plugin spaced-repetition
Last synced: about 1 year ago
JSON representation
Display interactive flashcards to formulate knowledge
- Host: GitHub
- URL: https://github.com/railly/obsidian-simple-flashcards
- Owner: Railly
- License: mit
- Created: 2024-01-18T20:54:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-16T05:57:39.000Z (over 1 year ago)
- Last Synced: 2025-04-06T04:42:55.814Z (about 1 year ago)
- Topics: flashcards, learning, memory, obsidian, obsidian-md, obsidian-plugin, spaced-repetition
- Language: TypeScript
- Homepage:
- Size: 2.98 MB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple Flashcards for Obsidian
Display interactive flashcards to formulate knowledge 🧠
## Features
🗃️ Standard Q&A flashcards
🎴 Cloze deletion flashcards for active recall
🔁 Customizable reveal methods (hover, button click, surface click)
🖋️ Inline cloze deletion with `{{word}}` syntax
🧠 Markdown support within code blocks.
## How to use it?
1. Insert a code block with the `flashcard` language tag.
2. Create a Q&A flashcard:
````markdown
```flashcard
Q: What is Obsidian?
A: Obsidian is a powerful knowledge base that works on top of a local folder of plain text Markdown files.
```
````
3. Create a cloze deletion flashcard::
````markdown
```flashcard
{{Obsidian}} is a powerful knowledge base that works on top of a local folder of plain text {{Markdown}} files.
```
````
4. Click on the flashcard to reveal the answer.
5. Optionally, configure the reveal method in the plugin settings.
## Demo
## Roadmap
1. Support `deck` fenced code block to group flashcards together. e.g.
````markdown
```deck
Q: What is Obsidian?
A: Obsidian is a powerful knowledge base that works on top of a local folder of plain text Markdown files.
---
{{Obsidian}} is a powerful knowledge base that works on top of a local folder of plain text {{Markdown}} files.
```
````
2. Implement spaced repetition algorithm.
3. A lot more to come!
## How to install
1. Install this plugin within Obsidian:
- Open Settings > Community plugins
- Make sure Safe mode is off
- Click Browse community plugins
- Search for "**Simple Flashcards**"
- Click Install
- Once installed, close the community plugins window and activate the newly installed plugin
2. Configure the plugin to your liking via the plugin settings accessible from the Obsidian settings panel.
## Contributing
Contributions are always welcome, whether in the form of bug reports, bug fixes, or feature ideas. Feel free to open an issue to discuss potential features or submit pull requests.
## Support
If you find this plugin helpful and wish to support ongoing development, consider buying me a coffee. Your support is greatly appreciated!
### GitHub Sponsors
### Buy Me a Coffee
### PayPal
### Yape
### Features
- 🗃️ Standard Q&A flashcards
- 🎴 Cloze deletion flashcards for active recall
- 🔁 Customizable reveal methods (hover, button click, surface click)
- 🖋️ Inline cloze deletion with {{word}} syntax
- 🧠 Markdown support within code blocks.