Setup

Requirements

requires Python 3.6+ (recommended 3.7+) and Sphinx.

You can install from PyPI.

$ pip install sphinx-revealjs

specify Sphinx and docutils expressly as dependencies. You get Sphinx by this command only.

does not provide revealjs builder instead of html builder. To use builder, edit your conf.py.

extensions = [
    "sphinx_revealjs",
]

if you want to configure more, edit conf.py with seeing ./configurations.

Run make command to build presentations. Files are generated to revealjs folder.

$ make revealjs

You can generate all pages as index.html to use dirrevealjs.

make dirrevealjs