This is the full developer documentation for Starlight Quiz
# Starlight Quiz
> Interactive quizzes for Astro and Starlight, authored in markdown.
**Starlight Quiz** adds interactive, self-marking quizzes to your Astro and Starlight documentation.
## Features
[Section titled “Features”](#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?
* [x] Single-choice questions
* [x] Multiple-choice questions
* [x] 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:
## Where next?
[Section titled “Where next?”](#where-next)
[Quick start](/starlight-quiz/guides/quick-start/)Install the plugin and write your first quiz.
[Multiple choice](/starlight-quiz/guides/multiple-choice/)Radio buttons, checkboxes and answer syntax.
[Fill-in-the-blank](/starlight-quiz/guides/fill-in-the-blank/)Text-input questions.
[Configuration](/starlight-quiz/guides/configuration/)Every plugin option and component prop.
[Live demo](/starlight-quiz/demo/)Every question type on one page.
## Reading these docs with an AI assistant
[Section titled “Reading these docs with an AI assistant”](#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`](https://ewels.github.io/starlight-quiz/llms.txt) (an index), [`llms-full.txt`](https://ewels.github.io/starlight-quiz/llms-full.txt) (everything) and [`llms-small.txt`](https://ewels.github.io/starlight-quiz/llms-small.txt) (trimmed for smaller context windows).
## Credits
[Section titled “Credits”](#credits)
**Starlight Quiz** is written by [Phil Ewels](https://github.com/ewels). It is a port of [mkdocs-quiz](https://github.com/ewels/mkdocs-quiz), which was originally written by [Sebastian Jörz](https://github.com/skyface753) before being rewritten by [Phil Ewels](https://github.com/ewels).
Writing docs with MkDocs instead?
Try [**mkdocs-quiz**](https://ewels.github.io/mkdocs-quiz/), which brings the same markdown quiz syntax to MkDocs and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
# Live demo
> Every question type and feature on a single page.
This page exercises every question type and feature. It also doubles as the fixture for the package’s end-to-end tests, so the quizzes here have stable ids. Switch each example to **Source** to see the markdown behind it.
Quiz answers on this page are saved to your browser's local storage and persist between visits.
Reset all answers
## Single choice
[Section titled “Single choice”](#single-choice)
* Preview
Which planet is known as the Red Planet?
* [ ] Venus
* [x] Mars
* [ ] Jupiter
* Source
quiz.mdx
```mdx
Which planet is known as the Red Planet?
- [ ] Venus
- [x] Mars
- [ ] Jupiter
```
## Multiple choice
[Section titled “Multiple choice”](#multiple-choice)
* Preview
Which of these are prime numbers?
* [x] 2
* [ ] 4
* [x] 7
* [ ] 9
* Source
quiz.mdx
```mdx
Which of these are prime numbers?
- [x] 2
- [ ] 4
- [x] 7
- [ ] 9
```
## Fill in the blank
[Section titled “Fill in the blank”](#fill-in-the-blank)
* Preview
The chemical symbol for water is \[\[H2O]].
* Source
quiz.mdx
```mdx
The chemical symbol for water is [[H2O]].
```
## Kitchen sink
[Section titled “Kitchen sink”](#kitchen-sink)
Most opt-in features at once: a `title`, shuffled answers, a manual Submit button (`autoSubmit={false}`), a retry button (`disableAfterSubmit={false}`), a formatted question with a code block, per-answer feedback, and a rich content section (heading, table, code and an image) revealed after submitting.
* Preview
Which language runs in the browser?
Which language runs **natively** in the browser, with no server or runtime required? Picture this running straight from a `