https://github.com/tombreit/mkdocs-quizdown-plugin

Allows embedding quizdown-js quizzes in MkDocs pages.
https://github.com/tombreit/mkdocs-quizdown-plugin

mkdocs mkdocs-plugin quiz

Last synced: 7 days ago
JSON representation

Allows embedding quizdown-js quizzes in MkDocs pages.

• Host: GitHub
• URL: https://github.com/tombreit/mkdocs-quizdown-plugin
• Owner: tombreit
• License: mit
• Created: 2024-12-25T22:54:41.000Z (8 days ago)
• Default Branch: main
• Last Pushed: 2024-12-27T12:16:16.000Z (7 days ago)
• Last Synced: 2024-12-27T12:27:36.715Z (7 days ago)
• Topics: mkdocs, mkdocs-plugin, quiz
• Language: Python
• Homepage:
• Size: 89.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# mkdocs-quizdown-plugin

**🔥 This is work in progress - no liability for nothing.**

- Allows embedding [quizdown-js](https://github.com/bonartm/quizdown-js) quizzes in MkDocs pages

## Install

*Currently only available via it's git repository.*

```bash

# Initial install:

python -m pip install \

  'mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin'

# Upgrade plugin:

python -m pip install \

  --upgrade --no-deps --force-reinstall \

  'mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin'

```

You can use the requirement item `'mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin'` in your `requirements.txt`:

```text

# file: requirements.txt

mkdocs

mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin

```

## Configuration

See [`mkdocs.yml`](https://github.com/tombreit/mkdocs-quizdown-plugin/blob/main/mkdocs.yml)

## Usage

Embed your quiz as a Markdown block in your MkDocs Markdown page and enclose it with the mkdocs-quizdown start (`:::{quizdown}`) and end markers (`:::`):

```md

# Quiz

Some **markdown** content.

:::{quizdown}

---

primaryColor: steelblue

shuffleQuestions: false

shuffleAnswers: true

---

# What is the capital of France?

> Paris is the capital and largest city of France.

1. [x] Paris

2. [ ] London

3. [ ] Berlin

4. [ ] Madrid

:::

Some **markdown** content.

```

- Try the [quizdown live editor](https://bonartm.github.io/quizdown-live-editor/) from the author of `quizdown-js` to prepare your quiz markdown

- [quizdown-js configuration options](https://github.com/bonartm/quizdown-js/blob/main/docs/options.md)

- MkDocs integration demo: [`docs/index.md`](docs/index.md)

## Credits

- [quizdown-js by Malte Bonart](https://github.com/bonartm/quizdown-js)

- [MkDocs](https://www.mkdocs.org/)