Note Quiz Engine

approvedunreviewed

by markdown-quiz

Turn notes into quizzes, practice multiple-choice and text questions, and track your scores in Markdown.

↓ 58 downloadsUpdated 20d agoMIT

Note Quiz Engine

English: README_EN.md

Obsidianのノートを、択一問題と記述問題の問題集に変えるプラグインです。問題の表示、採点、解説、正答率、成績履歴をMarkdownに保存します。AI連携は任意で、Claudianなどが作った問題も手書きの問題も同じ形式で使えます。

主な機能

  • 択一問題と記述問題、複数の正答文字列
  • 即時採点、解説、Score / Accuracy、再挑戦
  • quiz_source、quiz_created、Quiz Resultsの保存
  • Claudianなどへ渡す問題生成プロンプトと、1クリック生成
  • 生成言語の選択(日本語、English、元ノートと同じ言語)

インストール

  1. GitHub Releasesからnote-quiz-engine.zipをダウンロードします(Source codeではありません)。
  2. ZIPを解凍します。
  3. 中のnote-quiz-engineフォルダをVaultの.obsidian/plugins/へコピーします。
  4. Obsidianを再起動します。
  5. 設定 → コミュニティプラグイン → Note Quiz Engineを有効にします。

ZIPにはnote-quiz-engine/main.js、manifest.json、styles.cssだけが入っています。Node.jsやnpmは利用者には不要です。

使い方

ノートを開くと上部にGenerate quizとStart quizが表示されます。Generate quizはAIで新しい問題ノートを作成し、Start quizは現在のノートの問題を開始します。全問回答すると問題ノートの末尾に成績が保存されます。

AI / Claudianとの連携

Generate quizは現在のノートと設定したプロンプトをClaudianへ渡します。プラグインはLLM APIへ直接接続しません。Copilot、Codex、OpenCode、Ollamaなどを使う場合は、Generate quiz promptでプロンプトをコピーし、生成されたMarkdownをImport generated quiz from clipboardで取り込めます。

クイズ生成言語

設定 → Note Quiz Engine → Quiz generation languageで選びます。

  • 日本語: question、options、answers、explanationを日本語で生成します。
  • English: すべて英語で生成します。
  • 元ノートと同じ言語: 元ノートの言語を使います。

選択した言語はLLMプロバイダーの初期言語より優先されます。コマンド、ファイル名、API名などの技術識別子は必要に応じて原文で保持されます。

問題フォーマット

1つのMarkdownファイルに複数のnote-quizブロックを書けます。

```note-quiz
quiz:
  type: choice
  question: "メモリ使用状況を確認するコマンドは?"
  options:
    - "df"
    - "free"
  answer: 2
  explanation: "freeはメモリとswapを表示します。"
```

```note-quiz
quiz:
  type: text
  question: "メモリ使用状況を確認するコマンドを答えてください。"
  answers:
    - "free"
    - "free -h"
  explanation: "freeコマンドで確認できます。"
```

既存のquizブロックもStart quizで利用できます。インライン表示を使う新しいノートではnote-quizを使用してください。

アンインストール

設定 → コミュニティプラグインでNote Quiz Engineを無効化し、Vaultの.obsidian/plugins/note-quiz-engineフォルダを削除します。生成済みのMarkdown問題と成績は自動では削除されません。

開発者向け

pnpm install
pnpm run check
pnpm run package

Release ZIPはdist/note-quiz-engine.zipに生成されます。

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.