obsidian-plugin/chloedia_Obsidian_Quiz_Generator
1
0
Fork 0
mirror of https://github.com/chloedia/Obsidian_Quiz_Generator.git synced 2026-07-22 08:20:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
54 commits 4 branches 3 tags 1 MiB
TypeScript 92.7%
JavaScript 6.6%
CSS 0.7%
Find a file
Chloé Daems d278f32a14
Update README.md
2025-01-20 23:32:18 +01:00
src adding local llm suportm + improving json formating 2024-09-21 17:40:54 +02:00
.editorconfig Initial commit 2023-03-15 19:10:14 +01:00
.eslintignore Initial commit 2023-03-15 19:10:14 +01:00
.eslintrc Initial commit 2023-03-15 19:10:14 +01:00
.gitignore Upgrade question quality 2023-08-16 15:14:20 +02:00
.npmrc Initial commit 2023-03-15 19:10:14 +01:00
esbuild.config.mjs Base project 2023-06-09 13:38:10 +02:00
LICENSE Create LICENSE 2023-04-22 10:39:36 +02:00
manifest.json fix: version 2025-01-20 22:38:57 +01:00
package-lock.json fix: version 2025-01-20 22:38:57 +01:00
package.json Upgrade question quality 2023-08-16 15:14:20 +02:00
README.md Update README.md 2025-01-20 23:32:18 +01:00
styles.css Base project 2023-06-09 13:38:10 +02:00
tsconfig.json Initial commit 2023-03-15 19:10:14 +01:00
version-bump.mjs Initial commit 2023-03-15 19:10:14 +01:00
versions.json Initial commit 2023-03-15 19:10:14 +01:00

README.md

Obsidian Local FlashCard Generator

🚀 Supercharge your Obsidian workflow with QuizCraft, the revolutionary Obsidian plugin designed to transform your notes into dynamic flashcards. Seamlessly harness the power of LLMs, such as GPT-3 or GPT-4, or any OSS LLM to effortlessly generate customized flashcards from your notes. Prepare for exams, retain crucial information, and enhance your learning experience like never before.

Features

  • 📚 Generate quizzes that seamlessly integrate with the Spaced Repetition Obsidian plugin.
  • 🎯 Effortlessly transform your notes into curated quizzes tailored to your learning needs.

Setup

OpenAI

  1. 🔑 Obtain your OpenAI API key from here.
  2. ⚙️ Access the plugin settings in Obsidian by navigating to Settings > Flashcard Generator under Community Plugins.
  3. ✅ Untoggle the "Use Local LLM" option if you want OpenAI.
  4. 🛠️ Enter your OpenAI API key in the designated field.
  5. 💻 Choose which model (gpt3.5 or gpt4) you want to use.
  6. 🔢 Choose whether to limit the number of questions to 10.

Local LLM

  1. 🛠️ Install Ollama from here and follow the instructions to install it locally.
  2. ⚙️ Access the plugin settings in Obsidian by navigating to Settings > Flashcard Generator under Community Plugins.
  3. ✅ Toggle the "Use Local LLM" option if you want to use local models instead of OpenAI.
  4. 💻 Choose which model from ollama you want to use (you need to run a Model from Ollama first).

⚠ You might have a CORS issue, to fix it, go in you terminal and run export OLLAMA_ORIGINS="app://obsidian.md*"(mac/linux) or SETX /M OLLAMA_ORIGINS "app://obsidian.md*on Windows

Usage

Create comprehensive quizzes with ease:

  • 📝 Click the plugin icon while viewing your note to initiate the process.
  • ✅ Validate the relevance of generated questions for your study.
  • 🚀 Access the plugin via the Obsidian ribbon or use the "Create GPT-3 Quiz" command, customizable with a keyboard shortcut.

Contributing

Join us in enhancing QuizCraft:

  • 💡 Contribute to new feature development.
  • 🔜 Look forward to Customizable Learning: Craft flashcards that align perfectly with your study objectives. Specify the level of detail, format, and content you want on your cards, giving you complete control over your learning journey.

Links

Inspired by the code architecture of the obsidian-textgenerator-plugin.