Quiz plugin

[msoutopico]

Hi there,

I am looking for some mkdocs plugin that I could use to add quizzes to my documentation page. Is there such a thing?

I would like to add a question with a few answer options, only one of which is correct. The user would check the answer they think is correct, and if it 's the correct one, the will see a checkmark, if it's not correct they will see a red cross or something like that.

If no such plugin exist, perhaps this post should be moved from Q&A to Ideas.
Thanks.

[squidfunk]

I don't think there's currently such a plugin. You could consult the MkDocs Plugins Wiki or create one yourself!

[gabrielbdornas]

For @msoutopico and all interested in this question, I found the mkdocs-quiz plugin that does exactly what was asked for, add quizzes to the documentation pages.

Here you have a really nice implementation of the plugin. The content of the page is in Portuguese, but I think it's enough to grasp the plugin's potential.

Here, the GitHub repo for this project.

It basically:

• Install the package¹.
• Adds mkdocs_quiz to the mkdocs.yml plugin property.
• Adds quizzes based on the related structure:

<?quiz?>
question: Are you ready?
answer-correct: Yes!
answer: No!
answer: Maybe!
content:
<h2>Provide some additional content</h2>
<?/quiz?>

The project also better formatted the quiz structure, if you're interested in taking yours to the next level.

Enjoy!

Footnotes

1. the project uses poetry, but you could simply pip install mkdocs_quiz or add mkdocs_quiz to your requirements.txt file if you're using venv. ↩

[kdkiss]

I also wrote one if you do a search in GitHub you'll find it let me know if you have questions.