---
title: "mkdocs-quiz"
description: "Create interactive quizzes directly in your MkDocs markdown documentation."
url: "https://phil.ewels.co.uk/projects/mkdocs-quiz"
site: "phil.ewels.co.uk"
author: "Phil Ewels"
section: "Projects"
group: "Personal projects"
website: "https://ewels.github.io/mkdocs-quiz/"
github: "https://github.com/ewels/mkdocs-quiz"
---

# mkdocs-quiz

> Create interactive quizzes directly in your MkDocs markdown documentation.

[**mkdocs-quiz**](https://ewels.github.io/mkdocs-quiz/) is a plugin for [MkDocs](https://www.mkdocs.org/) that lets you build interactive quizzes inside your markdown documentation, handy for tutorials and educational content.

Quizzes use GitHub-flavoured markdown checkboxes inside a `<quiz>` block. Mark the correct answers with `- [x]` and the incorrect ones with `- [ ]`. Questions with one correct answer become radio buttons, and those with several become checkboxes.

```text
<quiz>
What's the best static site generator?
- [x] mkdocs
- [ ] Jekyll
- [ ] Sphinx
</quiz>
```

Features:

- **Simple markdown syntax** using GitHub-flavoured checkboxes
- **Multiple quiz types**: single choice (radio), multiple choice (checkboxes), and fill-in-the-blank
- **Instant feedback** marking correct and incorrect answers
- **Progress tracking** with a sidebar and a results panel
- **Results saved** to the browser's local storage
- **Internationalisation** for multi-lingual sites
- **LMS export** in QTI format for Canvas, Blackboard, and Moodle
- **CLI quiz runner** for taking quizzes in the terminal, from local files or deployed sites

The plugin was originally written by Sebastian Jörz. I rewrote it to add the interactive feedback, progress tracking, QTI export, and terminal runner.

See the [documentation](https://ewels.github.io/mkdocs-quiz/) and [source code on GitHub](https://github.com/ewels/mkdocs-quiz).

---

From the personal website of Phil Ewels, a software developer and bioinformatician in Stockholm, Sweden: https://phil.ewels.co.uk/
The whole site as Markdown: https://phil.ewels.co.uk/llms.txt
