mkdocs-superquiz

mkdocs-superquiz is a MkDocs plugin for complete heterogeneous page quizzes with multilingual authoring, configurable scoring, MathJax, saved answers, correction locking, relation drawing, drag-and-drop ordering, matrices and flashcards.

Page V1 public syntax

This version is intentionally breaking. One Markdown page is one complete quiz and every atomic question uses:

!!! question "Optional title"
    ---
    type: mcquiz
    points: 2
    ---
    Select every correct answer.

    answers:
      - [A]
      - B
      - [C]

Canonical types:

mcquiz, scquiz, blanks, scdropdown, mcdropdown,
order, columns, sentence,
match, match.line, match.bezier,
image, path, graph,
matrix, flashcard

Historical public quiz admonitions are not parsed. Only the exact built-in aliases documented in Page V1 are accepted as type: values; users may add additional aliases explicitly by language.

Installation

pip install mkdocs-superquiz

Enable the plugin in mkdocs.yml:

plugins:
  - search
  - superquiz

The full syntax, configuration hierarchy, scoring rules and executable examples are published on the GitLab Pages documentation site.

Development

The project uses Yarn 4, Vite, setuptools, MkDocs and GitLab CI.

corepack enable
yarn install
python -m pip install -e ".[dev]"

Main commands:

yarn dev
yarn build
yarn build:full
yarn build:full:check
yarn bfc

package.json is the version source of truth. Normal builds synchronize the Python package version automatically.

Verification

yarn bfc runs:

  • frontend and Python builds;
  • wheel and source-distribution checks;
  • MkDocs documentation build;
  • Python tests;
  • frontend tests;
  • browser smoke tests when Chromium is available;
  • JavaScript syntax checks;
  • protected-vendor checks;
  • canonical architecture checks for all 16 atomic types.

The required .gitlab-ci.yml workflow is part of the repository and must remain present in release archives.

Protected vendor assets

The vendored jsPlumb and QR-code files are not rewritten by Vite. Their SHA-256 hashes are checked during builds and tests.

License

GNU GPL-3.0-or-later.

Project links

Data verified by PyPI on Aug 2, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.6.2)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for Rod2ik from gravatar.com Rod2ik Avatar for Rodrigo1337 from gravatar.com Rodrigo1337

Credits

Author: Rod2ik, aka Rodrigo Schwencke

GitLab Statistics

Data verified by PyPI on Aug 2, 2026
The GitLab source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GNU General Public License v3 or later (GPLv3+) (GPL-3.0-or-later)

Requires

Python >=3.8

Provides Extra

dev

Tags

mkdocs quiz superquiz qcm plugin mc sc blanks dropdown order columns match graph flashcard mathjax i18n education interactive markdown

Classifiers

Report project as malware

Download files

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

Source Distribution

mkdocs_superquiz-0.3.6.tar.gz (332.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_superquiz-0.3.6-py3-none-any.whl (331.4 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_superquiz-0.3.6.tar.gz.

File metadata

  • Download URL: mkdocs_superquiz-0.3.6.tar.gz
  • Upload date:
  • Size: 332.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.14.6

File hashes

Hashes for mkdocs_superquiz-0.3.6.tar.gz
Algorithm Hash digest
SHA256 4c63977a594275540b510d48910c54f8faccdb963d6dc756e2a1e5c1caa76e92
MD5 7465fe661e63e8c9252bddc8c03d2529
BLAKE2b-256 20749b67ad16ce87731f3f4164196cc900de4ac7f8eb11d60514a7ac4fefb5e5

See more details on using hashes here.

File details

Details for the file mkdocs_superquiz-0.3.6-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_superquiz-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 252400bd8483854f697f0abcc57c96fde765f06b5391110b67dce7ef1864db1d
MD5 b65b75437740be44fb09e4d0de4dd635
BLAKE2b-256 d3c58cf8e6a80ba1fce047db8404383dcf801f269cb7c85b79af7f45f4d29e23

See more details on using hashes here.

Release history Release notifications | RSS feed

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.9

2 files

0.5.8

2 files

0.5.7

2 files

0.5.6

2 files

0.5.5

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.5

2 files

0.4.3

2 files

0.4.2

2 files

This release

0.3.6 This release

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.0

2 files

0.2.8

2 files

0.2.7

2 files

0.2.3

2 files

0.2.1

2 files

0.2.0

2 files

0.1.26

2 files

0.1.25

2 files

0.1.24

2 files

0.1.23

2 files

0.1.22

2 files

0.1.21

2 files

0.1.20

2 files

0.1.19

2 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page