Skip to main content

mkdocs-superquiz

mkdocs-superquiz is a MkDocs plugin for interactive multilingual quizzes, configurable scoring, MathJax content, saved answers, and correction unlocking with teacher codes and QR codes.

Installation

pip install mkdocs-superquiz

Enable the plugin in mkdocs.yml:

plugins:
  - search
  - superquiz

The complete installation, configuration and syntax documentation is published on the GitLab Pages site.

Development

The project uses a hybrid workflow:

  • Yarn 4 orchestrates development commands;
  • Vite compiles only the light and dark SCSS assets;
  • setuptools builds the Python wheel and source distribution;
  • MkDocs builds the documentation under public/;
  • GitLab CI publishes tagged releases to PyPI and creates GitLab Releases.

Install the development environment once:

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

The version in package.json is the single source of truth. Run yarn version:sync after changing it; normal builds do this automatically.

Protected vendor assets

The existing jsPlumb and QR Code files are intentionally kept as vendored runtime assets. Vite does not bundle, minify, or rewrite them. Their SHA-256 hashes are checked during every build and test.

License

GNU GPL-3.0-or-later.

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.2.0.tar.gz (296.0 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.2.0-py3-none-any.whl (304.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_superquiz-0.2.0.tar.gz
  • Upload date:
  • Size: 296.0 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.2.0.tar.gz
Algorithm Hash digest
SHA256 b096b5e68a9f87016019db4ca4ae427c3719bc9576dcab1a476494c0db113e5d
MD5 29b887a36398e4ed31f398e54c4be626
BLAKE2b-256 0947d1547245890da8d9256e2af89f3f6a8e17a509ff4b86d8e1a9c1815ee72f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_superquiz-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce3a4e99a64e553e6de09f5f10653d777e65f1dd4dec08dbe7bc9f9cf47f640e
MD5 e117936302273fe4c43d21f8fc2ead78
BLAKE2b-256 bdcd80d1708de94dd298616c6a51efdca9c6c82e2b771d860717ba70b3e9926b

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

0.3.6

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

This release

0.2.0 This release

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