Skip to content
Starlight QuizStarlight Quiz

Starlight Quiz

Starlight Quiz adds interactive, self-marking quizzes to your Astro and Starlight documentation.

Features

Section titled “Features”
  • ✨ Simple markdown syntax — write quizzes with GitHub-flavoured task lists. No new syntax to learn.
  • 🎯 Multiple quiz types — single choice, multiple choice and fill-in-the-blank.
  • ⚡ Instant feedback — per-answer feedback and visual correct/incorrect indicators.
  • 📝 Rich explanations — reveal a markdown content section after answering: code, tables and images.
  • 📊 Progress & results — an aggregate results panel with score tiers and confetti.
  • 💾 Results saved — answers persist to the browser’s local storage, surviving reloads and rebuilds.
  • 🔀 Author controls — shuffle answers, auto-number questions and set site-wide defaults.
  • 🌐 Internationalisation — 13 languages out of the box, shared with mkdocs-quiz.
  • 🧩 Works anywhere — a zero-config Starlight plugin or standalone in any Astro project.
  • ♿ Accessible — real fieldsets, aria-live feedback and keyboard-safe auto-submit.
  • 📤 LMS export — export to QTI 1.2/2.1 for Canvas, Moodle and Blackboard.
  • 🖥️ Terminal runner — take quizzes in your terminal, from a local build or a deployed site.

Try it:

Which of these does Starlight Quiz support out of the box?

  • Single-choice questions
  • Multiple-choice questions
  • Fill-in-the-blank questions
  • Mind reading

    Not yet, but everything else here is real.

When more than one answer is correct, the quiz automatically switches to checkboxes. Here’s a cat for getting this far:

A random cat, served fresh by cataas.com

Where next?

Section titled “Where next?”
Quick startInstall the plugin and write your first quiz.
Multiple choiceRadio buttons, checkboxes and answer syntax.
Fill-in-the-blankText-input questions.
ConfigurationEvery plugin option and component prop.
Live demoEvery question type on one page.

Reading these docs with an AI assistant

Section titled “Reading these docs with an AI assistant”

Every page has Copy Markdown and Open in… buttons beside its title, and serves its own source at the same URL with .md appended. The whole site is also available as llms.txt (an index), llms-full.txt (everything) and llms-small.txt (trimmed for smaller context windows).

Credits

Section titled “Credits”

Starlight Quiz is written by Phil Ewels. It is a port of mkdocs-quiz, which was originally written by Sebastian Jörz before being rewritten by Phil Ewels.