Skip to main content

A mkdocs plugin to create a quiz in your markdown document.

Project description

MkDocs Quiz Plugin

Demo

Create your first quiz

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

Info The answers can get styled with HTML (like <code>Yes!</code>)

Warning The quiz content needs to be valid HTML

Multiple choice

You can also create a multiple choice quiz, by providing multiple answers as correct.

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

Screenshots

Quiz (single choice)

Quiz (multiple choice)

Disable for a page

---
quiz: disable
---

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_quiz-0.0.41.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_quiz-0.0.41-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page