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

Project description

MkDocs Quiz Plugin

Create your first quiz

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

quiz-start quiz-question: Are you ready? quiz-answer-correct: Yes! quiz-answer: No! quiz-answer: Maybe! quiz-content:

Provide some additional content

quiz-end ```

Info The answers can 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-start
quiz-question: Are you ready?
quiz-answer-correct: Yes!
quiz-answer-correct: Maybe!
quiz-answer: No!
quiz-content:
<h4>Great!</h4>
quiz-end

Screenshots

Quiz (single choice)

Quiz (multiple choice)

Disable for a page

---
quiz: disable
---

Project details

Release history Release notifications | RSS feed

0.0.41

Dec 25, 2023

0.0.40

Dec 25, 2023

0.0.34

Dec 25, 2023

0.0.33

Dec 24, 2023

0.0.32

Dec 24, 2023

0.0.31

Dec 24, 2023

This version

0.0.4

Dec 25, 2023

0.0.3

Dec 24, 2023

0.0.2

Dec 24, 2023

0.0.1

Dec 24, 2023

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.4.tar.gz (4.0 kB view details)

Uploaded Dec 25, 2023 Source

Built Distribution

mkdocs_quiz-0.0.4-py3-none-any.whl (4.6 kB view details)

Uploaded Dec 25, 2023 Python 3

File details

Details for the file mkdocs_quiz-0.0.4.tar.gz.

File metadata

Download URL: mkdocs_quiz-0.0.4.tar.gz
Upload date: Dec 25, 2023
Size: 4.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for mkdocs_quiz-0.0.4.tar.gz
Algorithm	Hash digest
SHA256	`a36701b3a8c331e43429c25e489ec8604657965ed614fee01151dfded4db7c8f`
MD5	`fa05012441319a43df0db0786c4f3bc8`
BLAKE2b-256	`afe642e4f6d38a21b5bf3214d59f85dbc11aff341d771341427a10e1fce700d1`

See more details on using hashes here.

File details

Details for the file mkdocs_quiz-0.0.4-py3-none-any.whl.

File metadata

Download URL: mkdocs_quiz-0.0.4-py3-none-any.whl
Upload date: Dec 25, 2023
Size: 4.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for mkdocs_quiz-0.0.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`b84539433d23b30f1262049960a9f23a1e5e867ed7068fb6ea3378552678fbbe`
MD5	`341885d61a074eef2c596e0883e9c1a7`
BLAKE2b-256	`0909439e021d16dfc310bc0b7dd9c1fed8d72c7e42832b66753c60e9ce50d906`