sphinx-revealjs

Sphinx extention with theme to generate Reveal.js presentation

Orverview

This extension generate Reveal.js presentation from standard reStructuredText.

It include theses features.

• Custom builder to translate from reST to reveal.js style HTML
• Template to be enable to render presentation local imdependent

Installation

$ pip install sphinx-revealjs

Usage

1. Create your sphinx documentation

2. Edit conf.py to use this extension

   extensions = [
       'sphinx_revealjs',
   ]

3. Write source for standard document style

4. Build sources as Reveal.js presentation

   $ make revealjs

Change logs

See it

Futures

• Index template as none presentation
• CDN support

Contributings

GitHub repository does not have reveal.js library.

If you use from GitHub and editable mode, Run tools/fetch_revealjs.py after install.

$ git clone https://github.com/attakei/sphinx-revealjs
$ cd sphinx-revealjs
$ poetry install
$ poetry run python tools/fetch_revealjs.py

Copyright

Apache-2.0 license. Please see LICENSE.