This repository provides a template for creating JB2 books using MystMD. It is intended to be a general tool to support new users of Jupyter Book 2 and MystMD, in particular for use in workshop settings where participants may not have time or ability to install the required software on a personal computer.
The Workshop Template was created for JupyterCon 2025. Slides are in the Turing Way Github Organization: slides and repository.
- Configured as a GitHub template repository, allowing duplication with only a few clicks.
- Pre-configured structure for MystMD book projects using two MyST Templates:
book-themefor websites andplain_typst_bookfor PDF output. - Example content, configuration files and GitHub Actions workflow.
- Exercises for users to learn to easily edit and create content.
- Website and PDF are built and deployed using two separate GitHub Actions workflows.
- Installation and editing on a personal computer not required (due to GH Actions workflows).
If you are using this Template to learn to use Jupyter Book 2 and/or MystMD, visit the GitHub Pages site jupyter-book.github.io/workshop-template/ and follow the instructions.
If you have used this GitHub template repository to create a new book project, delete and/or modify the contents of this README and start editing your book!
The contents in this repository are shared with a CC BY 4.0 license unless otherwise noted. As this is work in progress, some reused content may not (yet) be listed here.
If you are using this template to create a new repository, specify your license in this section (we very strongly encourage CC BY 4.0!).
This project uses material from Freek Pols created for other book projects at Delft University of Technology. It also is (heavily) influenced by the TeachBooks Template for Jupyter Book 1.