mkdocs-revealjs

Embed one or more Reveal.js presentations directly inside MkDocs Markdown pages, with light/dark theme synchronization and native integration with other MkDocs plugins.

Documentation & live demos: https://rod2ik.gitlab.io/mkdocs-revealjs/

Modes

A page-wide presentation uses the canonical mode:

---
revealjs:
  mode: diapo
---

A Reveal.js evaluation powered by mkdocs-superquiz uses:

---
revealjs:
  mode: diapo.eval
---

There is intentionally no legacy presentation: syntax in 0.10.0.

Accepted mode aliases

Canonical	Accepted aliases
`diapo`	`diaporama`, `presentation`, `diapo.presentation`, `diapo.normal`
`diapo.eval`	`eval`, `evaluation`, `exam`, `examen`, `assessment`, `diapo.evaluation`, `diapo.exam`, `diapo.examen`, `diapo.assessment`

Documentation uses only the canonical forms after this table.

Multiple decks in one Markdown page

Use explicit deck blocks. Five or more = are accepted; the canonical form is:

Ordinary MkDocs content.

=====

# Slide 1

---

# Slide 2

=====/

Ordinary MkDocs content again.

Each block may start with local front matter:

=====

---
mode: diapo.eval
id: algebra-test
revealjs:
  transition: fade
superquiz:
  randomize: all
---

...slides...

=====/

id is optional. Missing identifiers are generated as diapo1, diapo2, eval1, eval2, ...

Optional Markdown imports with mkdocs-macros-plugin

Install the optional extra and enable macros before superquiz/revealjs:

pip install "mkdocs-revealjs[macros]"

plugins:
  - macros
  - superquiz
  - revealjs

Then import all explicit decks from another Markdown file at the exact insertion point:

{{ diapo("slides/demo.md") }}

Alias:

{{ include_diapo("slides/demo.md") }}

Select one explicitly named deck with a fragment:

{{ diapo("slides/demo.md#algebra-test") }}

Relative paths are resolved from the current Markdown source file. A leading / means the MkDocs docs_dir root, never the operating-system root. Imports may not escape docs_dir.

Configuration scopes

Reveal.js values resolve from least to most local:

built-in defaults < mkdocs.yml < page front matter < deck-local front matter

SuperQuiz adds its own per-type and per-question layers. An explicit deck is a scope: a diapo.eval deck owns its own evaluation session; an explicit normal diapo deck keeps its questions embedded even inside a page-level SuperQuiz evaluation.

Highlights

multiple independent Reveal.js decks per page;
horizontal and vertical slides;
Material light/dark synchronization, including Android Reveal Scroll View backgrounds;
Reveal.js, Highlight.js and Mermaid light/dark theming;
server-side compatibility islands for MkDocs extensions;
native mkdocs-superquiz, mkdocs-maths-admonitions, XTables and TikZJax integration;
fragments, notes, auto-animate and Reveal.js options;
optional diapo() / include_diapo() macros;
diapo.eval sessions with global SuperQuiz validation, scoring, timer, question navigation, and a dedicated post-validation result/violation-summary slide.
mkdocs-superquiz >= 0.5.5 evaluation toolbar integration: QR/timer/Reset/Unlock/live counts share one draggable deck toolbar, while numbered question navigation remains independently draggable. Strict defaults show QR + Reset and hide Unlock; transient violation warnings remain visually separate.

Development

yarn dev
yarn dev:lan
yarn build
yarn build:full
yarn bfc

yarn dev:lan binds MkDocs to 0.0.0.0:8000 for testing from a real phone on the same LAN.

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_revealjs-0.10.6.tar.gz (65.2 kB view details)

Uploaded Aug 12, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mkdocs_revealjs-0.10.6-py3-none-any.whl (54.9 kB view details)

Uploaded Aug 12, 2026 Python 3

File details

Details for the file mkdocs_revealjs-0.10.6.tar.gz.

File metadata

Download URL: mkdocs_revealjs-0.10.6.tar.gz
Upload date: Aug 12, 2026
Size: 65.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for mkdocs_revealjs-0.10.6.tar.gz
Algorithm	Hash digest
SHA256	`a8d5cd502ec0d236ba3fef8e706bbd83f848a410bc6804b47b307d2f4f154ebd`
MD5	`4e4f6130e12f398815750db172e278dd`
BLAKE2b-256	`9a06ac4675e882d6458ad809c9663a957e9feff2ea79242cc307127617dbaaa3`

See more details on using hashes here.

File details

Details for the file mkdocs_revealjs-0.10.6-py3-none-any.whl.

File metadata

Download URL: mkdocs_revealjs-0.10.6-py3-none-any.whl
Upload date: Aug 12, 2026
Size: 54.9 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for mkdocs_revealjs-0.10.6-py3-none-any.whl
Algorithm	Hash digest
SHA256	`f1455ad21d2fa86b7b68a576625f1df55eecc3dec123defdd3564886376c9f77`
MD5	`5212128d3986184bd5b97841d9d9e4b6`
BLAKE2b-256	`8f9f067a51d859d650537a98ff5264d012f96e6171617c7039293ec737d3fce7`