Skip to content

MkDocs Quiz Plugin

PyPI version Python versions License

A modern MkDocs plugin to create interactive quizzes directly in your markdown documentation. Perfect for educational content, tutorials, and documentation that requires user engagement.

Features

  • ✨ Simple markdown syntax - Create quizzes using GitHub-flavored markdown checkboxes
  • 🎯 Multiple quiz types - Single choice (radio), multiple choice (checkboxes), and fill-in-the-blank
  • ⚡ Instant feedback - Visual indicators show correct/incorrect answers
  • 📊 Progress tracking - Automatic progress sidebar and results panel, with confetti 🎉
  • 💾 Results saved - Answers are saved to the browser's local storage
  • 🌐 Internationalization - Quiz elements support multi-lingual sites
  • 🖥️ CLI Quiz Runner - Take quizzes in your terminal, from local files or deployed sites
<quiz>
What's the best static site generator? <!-- (1)! -->
- [x] mkdocs <!-- (2)! -->
- [ ] Jekyll <!-- (3)! -->
- [ ] Sphinx

If you entered mkdocs, you've come to the right place! <!-- (4)! -->
![Random cat gif](https://cataas.com/cat/gif)
</quiz>
  1. Your question (supports markdown)
  2. Correct answers are 'checked'
  3. Incorrect answers are unchecked
  4. Additional content at the bottom that shows after the question has been answered (supports arbitrary markdown and HTML).
#

What's the best static site generator?

Info

Quiz results are saved to your browser's local storage and will persist between sessions.

Changelog

See the Changelog for release history and updates.

Migrating from pre-v1? The CLI can automatically update your quizzes to the new syntax. See the Migration Guide for details.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Credits