Skip to main content

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

Project description

MkDocs Quiz Plugin

Create your first quiz

quiz-start
quiz-question: Are you ready?
quiz-answer-correct: <code>Yes!</code>
quiz-answer: No!
quiz-answer: Maybe!
quiz-content:
<h2>Provide some additional content</h2>
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


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

Uploaded Source

Built Distribution

mkdocs_quiz-0.0.34-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_quiz-0.0.34.tar.gz
  • Upload date:
  • Size: 3.9 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.34.tar.gz
Algorithm Hash digest
SHA256 fc480e2c98de5fd365533320c54f319c9369eb64dfa7e42e182bfcf062899c8f
MD5 32ed86572fb63646e94c3ab182f03f1c
BLAKE2b-256 784f506f1a3f2cac75d3088d3013f6e3d592f5404311833c1a0f43ae09b034c0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_quiz-0.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 da4a62461a797e44e1e9d2eca1bbb467339cae810c6d4b13834c830538276608
MD5 a346a76a8cfb9f7a9ae7d3df1b3f2f72
BLAKE2b-256 8c59fb4ff3d693ff1b1c83c094169ff691502da857a6f7208dd4c47a8d4bce7f

See more details on using hashes here.

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