Make awesome reveal.js presentations with revelation
- Presentation server to run it locally when you are offline.
- Presentation creation from template with a single command.
- Custom theming support with css.
- Export to static html tool.
- Debug mode with server auto refresh.
You can install it with:
pip install revelation
Or with pipx:
pipx install revelation
Install/Update revealjs files
Revelation depends on revealjs to run its presentation and every command bellow will check and install it if revealjs isn't installed yet.
But, you can also manually install or even update it to a different version with the
Creating a new Presentation
To create a new presentation you can use
mkpresentation command that will setup a new presentation using the base layout for you:
revelation mkpresentation mypresentation
Running the Presentation
You can start presenting with the
start command on your presentation markdown file:
cd mypresentation revelation start slides.md
To export the presentation as static HTML content use the command:
revelation mkstatic slides.md
- Run the presentation with revelation.
- Open your browser with the
print-pdfas query string like :
- Open the in-browser print dialog (CTRL+P or CMD+P).
- Change the Destination setting to Save as PDF.
- Change the Layout to Landscape.
- Change the Margins to None.
- Enable the Background graphics option.
- Click Save.
Alternatively you can use the decktape project.
The base presentation file structure looks like this:
presentation/ |- media/ |- theme/ |- config.py |- slides.md
The slides.md File
This is your presentation file written using markdown with some especial tags described on markdown section and is placed on your presentation root folder.
Split your slides by setting up a slide separator and vertical slide separator into REVEAL_CONFIG. Default separator are
The media folder
By default, revelation looks for a folder called media inside your presentation root folder. All media placed inside it can be referenced on your presentation by the path
You can define a custom media path using the
--media option on revelation
The theme folder
You can create your custom theme file and place it inside a theme folder and reference it at the configuration file by the option
The config.py File
The configuration file located in the root folder of your presentation, allows you to customize your presentation. This file is optional and have the following configuration options:
- REVEAL_META: Metadata of your presentation, mostly to identify the author and title.
- REVEAL_THEME: A string where you can select the theme you would like to use. All revealjs base themes are available.
- REVEAL_CONFIG: A python dictionary with the revealjs configuration attributes but using python types (e.g.: true is python boolean True)
Once you create a new presentation, all configuration values will be there for you to customize.
The markdown used on the presentation files support everything that revealjs docs allows to place inside the
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for revelation-2.1.0-py3-none-any.whl