Metadata-Version: 2.4
Name: mkdocs-superquiz
Version: 0.2.0
Summary: MkDocs plugin to create interactive, multilingual quizzes with scoring, MathJax support and QR-code correction unlocking
Author-email: "Rod2ik, aka Rodrigo Schwencke" <rod2ik.dev@gmail.com>
License: GPL-3.0-or-later
Project-URL: Homepage, https://rod2ik.gitlab.io/mkdocs-superquiz/
Project-URL: Documentation, https://rod2ik.gitlab.io/mkdocs-superquiz/
Project-URL: Repository, https://gitlab.com/rod2ik/mkdocs-superquiz
Project-URL: Issues, https://gitlab.com/rod2ik/mkdocs-superquiz/-/issues
Keywords: mkdocs,quiz,superquiz,qcm,plugin,mcquiz,scquiz,fillblanks,dropdown,orderquiz,linematchquiz,matchquiz,mathjax,i18n,education,interactive,markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: MkDocs
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Education
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs<2.0,>=1.5
Requires-Dist: pymdown-extensions>=10.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: mkdocs-material<10,>=9; extra == "dev"
Requires-Dist: mkdocs-revealjs; extra == "dev"
Requires-Dist: pytest<9,>=7; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: twine>=6; extra == "dev"
Dynamic: license-file

# 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

```bash
pip install mkdocs-superquiz
```

Enable the plugin in `mkdocs.yml`:

```yaml
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:

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

Main commands:

```bash
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.
