# Starlight Quiz

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

## 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:

<Quiz id="home-taster">
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:

<img
  src="https://cataas.com/cat/gif"
  alt="A random cat, served fresh by cataas.com"
  width="480"
  style="max-width: 100%; height: auto; border-radius: 0.5rem;"
/>

</Quiz>

## Where next?

[Quick start](/starlight-quiz/guides/quick-start/)
  [Multiple choice](/starlight-quiz/guides/multiple-choice/)
  [Fill-in-the-blank](/starlight-quiz/guides/fill-in-the-blank/)
  [Configuration](/starlight-quiz/guides/configuration/)
  [Live demo](/starlight-quiz/demo/)
## 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

**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).

<div class="mkdocs-tip">
**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/).
</div>