Revealer is an overlay of reveal.js designed to easily create beautiful scientific presentations.
In a mindset close to LaTeX, a presentation is a single text file (.pres)
holding both its parameters and its content; media live in an associated folder.
A command-line tool downloads and updates the reveal.js engine and its plugins
for you, and a near-WYSIWYG loop is available inside VS Code.
📖 Full documentation: https://candelierlab.github.io/Revealer
Requires Python ≥ 3.11. pipx is recommended:
git clone https://github.com/CandelierLab/Revealer.git
cd Revealer
pipx install .This installs the revealer command, together with all its Python
dependencies (typer, questionary, rich, tomli-w, bibtexparser) in an
isolated environment — there is nothing else to install by hand.
revealer root ~/Presentations # remember where presentations live
revealer new MyTalk # scaffold a folder + reveal.js + MyTalk.pres
revealer build MyTalk # generate the HTMLOther commands: revealer open, revealer pdf, revealer select,
revealer list, revealer plugins, revealer update [--force]. See the
CLI documentation.
With the Run on save and Live Server extensions, saving a .pres file
rebuilds the presentation and the browser reloads it live. Configure Run on
save to run revealer build '${file}'; see the
installation guide.
# --- SETTINGS ---
> author: First author
> event: Somewhere, 01/01/2026
> theme: revealer
> slideNumber: c/t
# --- CONTENT ---
>>> first: My presentation
> subtitle: Based on reveal.js
=== A slide
This slide is <i>very</i> informative.
* Bullet one
* Bullet two
The full syntax (slides, columns, code, citations, dark mode, SVG animation, …) is documented at https://candelierlab.github.io/Revealer.
Two themes ship in: revealer (default, neutral) and ljp (Laboratoire Jean
Perrin branding). Any stock reveal.js theme also works. Select one with
> theme: <name> in the settings.
reveal.js is © Hakim El Hattab and released under the MIT license.