/sphinx-revealjs

Sphinx builder to revealjs presentations

Primary LanguagePythonApache License 2.0Apache-2.0

sphinx-revealjs

https://travis-ci.org/attakei/sphinx-revealjs.svg?branch=master

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

Copyright

Apache-2.0 license. Please see LICENSE.