Installation¶
mkdocs-quiz requires Python 3.8 or higher and MkDocs 1.0.0 or higher. It's designed to work with mkdocs-material, and is not guaranteed to work with other mkdocs themes.
To install mkdocs-quiz from PyPI, you can use pip:
pip install mkdocs-quiz
If your project has a requirements.txt file, add mkdocs-quiz to it and run:
pip install -r requirements.txt
If you're managing your project with uv, you can add it as follows:
uv add mkdocs-quiz
Or to install globally:
uv pip install mkdocs-quiz
For development or to get the latest unreleased features:
git clone https://github.com/ewels/mkdocs-quiz.git
cd mkdocs-quiz
pip install -e ".[dev]"
Enabling the Plugin¶
Add the plugin to your mkdocs.yml configuration file:
plugins:
- mkdocs-quiz
That's it! The plugin is now active and will process all quiz blocks in your markdown files.
Configuration¶
See the Configuration page for all available options.