This is the Jupyter Book 2 Workshop Template, designed to quickly and easily produce your own online interactive textbook as well as a high quality PDF enabled with Typst using Jupyter Book 2 technology.
This template:
provides a ready-to-use Jupyter Book 2 structure for creating an online book (i.e., website),
includes a number of lessons to get started understanding key components of a book and how to edit it,
includes a GitHub Action workflow to automatically build and deploy your book online,
provides instructions for generating a high quality PDF with Typst using a ready-to-go template, then deploy it online automatically using GitHub Actions.
Hence, the template allows you to engage with JB2 (and the underlying software MyST) without installing any software on your own computer. You only need a web browser and a GitHub account (we provide details on how to work locally on your own computer). For those who are comfortable installing software locally (i.e., with a CLI) and/or do not want to use the template book structure, use the Advanced Start instructions, denoted with red hot 🌶.
As this document serves both as a template and a guide, it has the following structure:
A quick introduction to key Jupyter Book 2, MyST and Markdown concepts.
A tutorial with several steps to introduce you to editing and building your own book.
Additional resources, for example, Advanced Start instructions and Software.