A minimal and pip-installable jupyter nbconvert template for KULeuven slides.
Project description
Jupyter KULeuven slides Template
A nbconvert template to convert jupyterlab notebooks into reveal.js slides using the KULeuven presentation style.
Installation instructions
This nbconvert template can be installed using pip:
pip install jupyter-KULeuven-Slides
This will make the reveal.js template "KULeuven" available in the python environment.
Basic usage
First mark (using the property inspector
menu at the left hand side) the start of each slide in any existing Jupyter notebook, by selecting slide
under the topic Slide type
.
Subsequently, using the jupyterlab top-menu, please select :File
-> Save and Export Notebook as
-> KULeuven
Command line
Converting Jupyter notebooks into templated KULeuven slides can also be done from the command line as follows:
jupyter nbconvert --to KULeuven Notebook.ipynb
or converting all notebooks in a folder:
jupyter nbconvert --to KULeuven *.ipynb
Adding and modifying the title slide
You can add a title slide, by adding the notebook metadata a section labeled KULeuvenslides
. In this section the following tags can be optionally added:
"KULeuvenSlides": {
"title": "test title",
"subtitle": "test subtitle",
"authors": "Jan Genoe",
"location": "Ergens",
"date": "Vandaag"
},
Please do not forget to commit these changes to the jupyter notebook changes after adding this metadata. (The small v on top of the box). The screenshot below shows a possible implementation:
Please do not forget to commit changes after adding metadata. (The small v on top of the box).
Selecting a global template
The following global templates are available:
- Sedes
- Normal
- 1425 (The key referring to the foundation date of our university)
In this folder you can find 3 jupyter notebooks
that are converted according to each of those 3 templates.
The Normal
template is added by adding to the notebook metadata
"KULeuvenSlides": {
"kuleuven_presentation_style": "Normal"
},
Please do not forget to commit changes after adding metadata. (The small v on top of the box).
Adding a structure slide in the presentation, using a different template
A structure slide, typically for the outline of the presentation, can be added at any point in the presentation by adding to the cell metadata under KULeuvenSlides
:
"KULeuvenSlides": {
"slide_code": "structure"
},
(typically there will be already the slide_type
present in this section)
Please do not forget to commit changes after adding metadata. (The small v on top of the box).
Develop notes
For building and developing this template has been used.
For the reveal.js template that is used as a source, please see here
See here for nbconvert's documentation on creating custom templates.
MIT License
Copyright (c) 2021 KULeuven
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyter-KULeuven-slides-0.3.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bd1f9637234c7126700f96babdbc3f2add7b78d0e12bbca8225264c8ccb3355 |
|
MD5 | 0b5283e8134c1b8ebc9131e82e81690d |
|
BLAKE2b-256 | 88b308f347cc12b3afc64aebbe20647f7b4878402a029da0ef32751dac913bdb |
Hashes for jupyter_KULeuven_slides-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6abd8a99103f02ed1e4f88ce74801c85037927355015d521275760c9467bab64 |
|
MD5 | 99f64bfc1908497ca70195c72becfdef |
|
BLAKE2b-256 | 01581f3ad2d67be3bb779f6a10445a54546eed2936b166165fc400c874c1d943 |