README file from
GithubDeep Notes
Turn your Obsidian notes into an active study session powered by AI.
What is Deep Notes?
Deep Notes is an Obsidian plugin that transforms your notes into an interactive learning experience. Open any note, pick a study mode, and let AI generate questions tailored to your content. Answer, get evaluated, and schedule your next review without leaving Obsidian.
Study Modes
| Mode | Description |
|---|---|
| Socratic | AI generates open-ended questions from your note. Answer in your own words and get detailed feedback. |
| MCQ | Multiple choice questions on your note content. Answer all, then get a score. |
| Feynman | Explain a concept back as if teaching someone else. AI evaluates your depth and clarity. |
| Flashcards | Front/back cards generated from your note. Click to flip, export to Markdown when done. |
Installation
- Open Obsidian Settings → Community Plugins → turn off Restricted Mode
- Click Browse and search for Deep Notes
- Click Install, then Enable
Setup
Deep Notes requires one AI provider to generate and evaluate questions:
- Gemini (recommended): Get a free API key at aistudio.google.com and paste it in the plugin settings
- Ollama (local/offline): Install Ollama and pull a model (e.g.
ollama pull llama3.2)
Quick Start
- Open any markdown note in Obsidian
- Open the Deep Notes panel from the sidebar
- Select a study mode and click Generate Questions
- Answer the questions, hit Evaluate & save session, and schedule your review
Contributing
Contributions are welcome. See CONTRIBUTING.md for setup instructions, code style, and the PR process.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Support & Authors
If you encounter issues, need help, or want to provide feedback, please open an issue on GitHub Issues or contact the maintainers directly:
- Aaditya Dhungana — [email protected]
- Emmanuel Buhari — [email protected]
- Noah Nguyen — [email protected]
Buy Us a Coffee
If you enjoy Deep Notes and want to support further development, you can buy us a coffee!