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.
Refactor verification
The current modular frontend covers six quiz types. Run the complete build and verification with:
yarn bfc
The test chain includes Python characterization, frontend scoring matrices, runtime parity and a
Chromium smoke test when Chromium is installed and local test pages are permitted. Use MKSQ_REQUIRE_BROWSER_SMOKE=1 yarn test:browser when CI must treat a missing or policy-blocked browser as an error.
Sentence alternatives
For orderquiz with mode: sentence, multiple accepted answers are scored and corrected against the best matching accepted sentence. An unused equivalent token is displayed with a dashed alternative state when another valid token already occupies that position. Moving a token or using Reset All returns sentence tokens to a neutral visual state.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_superquiz-0.2.3.tar.gz.
File metadata
- Download URL: mkdocs_superquiz-0.2.3.tar.gz
- Upload date:
- Size: 288.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cca4dab19196ac584a23a5b5c2c86bf99506ddec0e5eaba2ebaf004c13dbbe15
|
|
| MD5 |
bfffbfa584b19e29b125cb4d3ea5c300
|
|
| BLAKE2b-256 |
00797988775fd20cd76d3245f54b334713351dd10dc893d9df158eb648fe0aad
|
File details
Details for the file mkdocs_superquiz-0.2.3-py3-none-any.whl.
File metadata
- Download URL: mkdocs_superquiz-0.2.3-py3-none-any.whl
- Upload date:
- Size: 290.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f9ec1ae7d7c0e2fe1f32501e7ed42e737272482388af825ca889630c00edef9a
|
|
| MD5 |
2bee26665949371ded84c38bb13f928b
|
|
| BLAKE2b-256 |
d4a09d11b241c13ed8ec4b49b9a78b58cdb8e145169a600bdcb8a0d4f8e96911
|
