- Create a markdown file under
slidessubfolder following the naming convention with the date as prefix - Write your slides using the reveal-md syntax
- Push on the default branch (
main) onorigin(https://github.com/geotribu/slides/) - The CI/CD build and publish slides on the Github Pages website
This project uses MkSlides to convert Markdown into static HTML.
Requirements:
- Python >= 3.12
- NodeJS LTS to edit the theme
Install (typically on Ubuntu):
python3 -m venv .venv
# on Windows, it should be something like this:
# py -3 -m venv .venv
. .venv/bin/activate
# on Windows, it should be something like this:
# .venv\Scripts\activate
python -m pip install -U pip
python -m pip install .mkslides build slides/The generated website is under site subfolder.
mkslides serve slides/The website is served on http://localhost:8000 (you can customize the port with -p option in case of conflict) and autoreloaded when a file is changed.
Download required files using the helper script:
python theme/scsstocss.pyImportant
The file theme/slides/geotribu.css is autogenerated from the theme/slides/geotribu.scss. It's tracked for convenience. Do not edit it manually.
To generate the theme CSS file:
npx sass theme/slides/geotribu.scss theme/slides/geotribu.cssBy default, you can find an hyperlink on the index pages that generates an HTML page ready to be print as PDF. It
Here comes an example (replace with your own slides URL and output filename):
docker run --name decktape --rm -v "./:/slides" astefanutti/decktape https://geotribu.github.io/slides/2025-02-13_geotribu_introduction_en.html output.pdfYou can also specify author, title and subject:
docker run --name decktape --rm -v "./:/slides" astefanutti/decktape --pdf-author "Julien Moura (Geotribu)" --pdf-title "Introducing the Geotribu project" --pdf-subject "Slides to introduce the project Geotribu." https://geotribu.github.io/slides/2025-02-13_geotribu_introduction_en.html output.pdf