voila-reveal
voila-reveal copied to clipboard
Slideshow template for Voilà based on RevealJS
voila-reveal
A reveal-based template for Voilà.
⚠️ Voilà-Reveal has been integrated in the core Voilà project ⚠️
As of version 0.3 of Voilà, this package is not necessary.
Installation (for Voilà <0.3)
voila-reveal
can be installed from PyPI
pip install voila-reveal
Or from conda-forge:
mamba install -c conda-forge voila-reveal
Usage
To use the reveal
template, pass --template=reveal
to the voila
command line:
voila --template=reveal notebooks/reveal.ipynb
It is possible to overwrite resource defaults by passing additional options. For instance, the default value of transition is "fade". To get the "zoom" behaviour:
voila index.ipynb --template=reveal --VoilaConfiguration.resources="{'reveal': {'transition': 'zoom'}}"
To configure the template with a configuration file, create conf.json
under PREFIX/share/jupyter/voila/templates/reveal/
with the following content:
{
"traitlet_configuration": {
"resources": {
"reveal": {
"scroll": false,
"theme": "simple",
"transition": "zoom"
}
}
}
}
License
We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.
This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.