HTML Presentation builder for Pythonista
.. image:: https://img.shields.io/pypi/v/sphinx-revealjs.svg :target: https://pypi.org/project/sphinx-revealjs/
.. image:: https://github.com/attakei/sphinx-revealjs/actions/workflows/main.yml/badge.svg :target: https://github.com/attakei/sphinx-revealjs/actions
.. image:: https://readthedocs.org/projects/sphinx-revealjs/badge/?version=latest :target: https://sphinx-revealjs.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
Sphinx extension with theme to generate Reveal.js presentation
This extension generate Reveal.js presentation from standard reStructuredText.
It include theses features.
For more information, refer to the documentation <https://sphinx-revealjs.readthedocs.io/>
_.
.. code-block:: bash
$ pip install sphinx-revealjs
Create your sphinx documentation
Edit conf.py
to use this extension
.. code-block:: python
extensions = [
'sphinx_revealjs',
]
Write source for standard document style
Build sources as Reveal.js presentation
.. code-block:: bash
$ make revealjs
See it <./CHANGES.rst>
_
This is implemented based Reveal.js. I plan to update it at patch-version for catch up when new Reveal.js version released.
GitHub repository does not have reveal.js library.
If you use from GitHub and editable mode, Run tools/fetch_revealjs.py
after install.
.. code-block:: bash
$ git clone https://github.com/attakei/sphinx-revealjs
$ cd sphinx-revealjs
$ python tools/fetch_revealjs.py
For more information, See CONTRIBUTING.rst <./CONTRIBUTING.rst>
_ and "contributing" <https://sphinx-revealjs.readthedocs.io/en/stable/contributing/>
_ page in documentation.
Apache-2.0 license. Please see LICENSE <./LICENSE>
_.