Deveal, a reveal.js helper tool
Deveal is an helper tool for using the marvelous reveal.js presentation framework.
It provides the ability to
create a new presentation
split presentation into multiple files
easily parameterize the presentation (title, theme, custom css, …)
build presentation into a single index.html file
watch for presentation updates while editing the source files
Deveal is developped in Python 3 and mainly relies on the wonderful Jinja2, PyYaml and watchdog packages.
Installation
Use the pip installation tool
pip install devealThe dependencies will be automatically installed.
Usage
Deveal is a command line tool. It must be used from within a terminal.
Run the following command to get help
deveal --helpdeveal new
The deveal new command creates a new presentation. As it creates the presentation directory itself, the command must be run in the upper directory where the new presentation will be created
(example below for creating a new presentation named “mynewslideshow”)
deveal new mynewslideshowThis command creates the minimal required files in the presentation directory
the deveal-index.html template file
the deveal.yaml configuration file
A deveal.css file for optional custom styles and a sections directory with an example presentation are also created
The deveal-index.html file is the template for the presentation. It a Jinja2 template rendered throught the deveal build command, using the variables contained in the deveal.yaml file. Unless you want to modify the reveal.js configuration, you should not have to modify this template.
The deveal.yaml file contains the configuration for the presentation. It should contains the folling expected variables:
reveal_path : The path or URL to the installed reveal.js framework (default is “https://cdn.jsdelivr.net/npm/reveal.js@4.1.0”)
reveal_theme : The theme to use for (default is “black”)
content_files : The ordered array of files containing the parts of the presentation
custom_css : The path to custom css files if any
Any other variable defined in this file is made available as a variable for the template file. This may be useful to customize the base template.
deveal build
The deveal build command builds the presentation as a single index.html file using the deveal-index.html and deveal.yaml files
deveal buildThe obtained index.html file is the presentation itself that can be open throught a web browser.
deveal watch
The deveal watch command watches for files changes in the presentation directory and subdirectories. If a change is detected, a build is automatically triggered. Type Ctrl+C to stop watching.
deveal watchTips
For an easier writing and maintenance of the presentation, it is encouraged to split the presentation into multiple files (for example title.html, part1.html, part2.html, …)
it is encouraged to put the graphics used in the presentation in a dedicated subdirectory (named “graphics” for example)
1 maintainer
Metadata
1 maintainer
Release files for deveal 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| deveal-1.3.0.tar.gz | 7.9 kB | Without provenance | Details for deveal-1.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| deveal-1.3.0-py3-none-any.whl | Python 3 | none | any | Details for deveal-1.3.0-py3-none-any.whl |
Total release size: 16.1 kB
Release files / deveal-1.3.0.tar.gz
| Download URL | deveal-1.3.0.tar.gz |
|---|---|
| Size | 7.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
99ca20e61f9374497ded8deeb7ccc16c3ddab5647cc0a97baa89e19795387c19
|
|
BLAKE2b-256 checksum How to use checksums |
b77a307b1b35126f307c3597b1a15c9c7206c8a0e53b24d6bbbc8282f15fe2b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.10
|
Release files / deveal-1.3.0-py3-none-any.whl
| Download URL | deveal-1.3.0-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
63c8e9e251cb876111aa0e2ca98d6edaa76185d342c0416d8c13837e082d3a7c
|
|
BLAKE2b-256 checksum How to use checksums |
3dc3fadd049504160ab213d5f4bb5e1694cecc3886ffda354c305fe0aa103a4f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.10
|
Security for deveal 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
