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
  • 🎯 Single and multiple choice - One correct answer = radio buttons, multiple = checkboxes
  • âš¡ Instant feedback - Visual indicators show correct/incorrect answers
  • 📊 Progress tracking - Automatic progress sidebar and results panel, with confetti 🎉
<quiz>
What's the best static site generator? <!-- (1)! -->
- [x] mkdocs <!-- (2)! -->
- [ ] Jekyll <!-- (3)! -->
- [ ] Sphinx

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.

License

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

Credits