A Flashcard app that reads from markdown files.
Build flashcards/quizzes from your Markdown files (personal wiki/knowledge base). Use this app to help commit info from your knowledge base to long-term memory.
Has latest stable release of the app and tutorial deck, see it: mdfc-main.netlify.app.
- Take markdown files as input and generate flashcards/quizzes
- Handle large decks by breaking it down to multiple quiz sessions
- Repeat incorrect questions as a cheap imitation of "spaced repetition"
- Accessible on any device (with internet)
- Can resume quiz progress
- Has basic stats
- Handles basic text content & any code content
- Gatsby.js
v5.5(react, TS, GraphQL, used as I was familiar with its ability to generate data from .md files and quickly publish online) - Tailwind CSS
v3.3(fast styling with utility-first CSS framework) - highlight.js
v11.9(code content syntax highlighting) - External: Netlify (optional, used to host the app & quickly deploy content updates)
- Fork & clone this repo
- Make sure you have Node
v18, in terminal go to DIR & runyarn - On successful installation, run
yarn develop - Go through the tutorial deck to get familiar with the app & how to update it to use your own content (or see:
src/questions-tutorial/6 thanks and closing.md)
- Any issues, questions or suggestions, let me know via github
- Plans for future development, but could be a while...
- App v1.x: 🛠️ fix: all TS errors
- App v1.x: ✅ TS entire app
- App v1.x: ✅ unit tests
- App v1.x: ✅ view to see all questions wrong & right
- App v1.x: ✅ light dark theme (top level theming)
- App v1.x: ✅ works with JSON obj of certain shape
- App v1.x: ✅ categories
- App v1.x: ✅ simple persistent analytics
- App v1.x: ✅ cover overflow-y content container to have bottom shadow fade visual
If you're coming from Obsidian you'll need to update the image syntax:
- In
/questionsfolder, find all