Package: revelation
Revelationrevelationis a cli tool that makes yourrevealjspresentations nice and easy using markdown and serving it locally.FeaturesPresentation 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.InstallationYou can install it with:pipinstallrevelationOr withpipx:pipxinstallrevelationUsageInstall/Update revealjs filesRevelation 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 theinstallrevealcommand:revelationinstallrevealCreating a new PresentationTo create a new presentation you can usemkpresentationcommand that will setup a new presentation using the base layout for you:revelationmkpresentationmypresentationRunning the PresentationYou can start presenting with thestartcommand on your presentation markdown file:cdmypresentation
revelationstartslides.mdStatic ExportTo export the presentation as static HTML content use the command:revelationmkstaticslides.mdPDF ExportPresentations can be exported to PDF via a special print stylesheet. This feature will be described usingGoogle ChromeorChromium, but I got the same results usingFirefox.Run the presentation with revelation.Open your browser with theprint-pdfas query string like :localhost:5000/?print-pdf.Open the in-browser print dialog (CTRL+P or CMD+P).Change theDestinationsetting toSave as PDF.Change theLayouttoLandscape.Change theMarginstoNone.Enable theBackground graphicsoption.ClickSave.Alternatively you can use thedecktapeproject.Presentation SetupThe base presentation file structure looks like this:presentation/
|- media/
|- theme/
|- config.py
|- slides.mdThe slides.md FileThis is your presentation file written using markdown with some especial tags described onmarkdown sectionand is placed on your presentation root folder.Split your slides by setting up aslide separatorandvertical slide separatorintoREVEAL_CONFIG. Default separator are---and---~.The media folderBy default, revelation looks for a folder calledmediainside your presentation root folder. All media placed inside it can be referenced on your presentation by the path/media:![Python Logo](media/python.png)You can define a custom media path using the--mediaoption on revelationstartcommand.The theme folderYou can create your custom theme file and place it inside athemefolder and reference it at the configuration file by the option--theme.The config.py FileThe 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 therevealjs configuration attributesbut 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.MarkdownThe markdown used on the presentation files support everything thatrevealjs docsallows to place inside thedata-templatesection.