Which template should I use?

We offer three templates, each with its own pros and cons. We specify below the characteristics in order to help you pick the ‘best’ template that fits your needs and level of expertise.

All templates provide the same starting chapters, telling a little about the markdown language, and providing some exercises to help you get started.

Jupyter Demo Book¶

The Jupyter Demo Book template (adapted from the original Jupyter Book templated by Timon Idema) is based on the Jupyter Book 1 software and utilizes TU Delft Gitlab. Full software installation is required to produce an output.

pro’s:

• bare bone version

• software developed and support by JB1 developers

cons:

• Full software installation to see output

• No full control unless coded yourself

• Difficult to set up

• OIT support needed to get started

• PDF export suboptimal

Example book made utilizing the template: A Brief Introduction to Biochemistry: Biochemistry for non-chemists

Requirements¶

• VSC

  • Extensions

    • Jupyter

    • Markdown

    • Github Actions

    • Python

• Python

  • Dependencies

    • jupyter-book

    • numpy

    • scipy

    • matplotlib

    • plotly==5.24.1

    • myst_nb

    • jupyterquiz

    • sphinx-exercise

    • sphinx-proof

    • pydata-sphinx-theme

• Gitlab

Teachbooks¶

The Teachbooks template (developed by Tom van Woudenberg, Robert Lanzafame and Dennis den Ouden-van der Horst) is based on the Jupyter Book 1 software and utilizes Microsoft Github. It is recommended to install full software to run the book locally, but is not required through the use of GitHub Pages.

pro’s:

• Quick start

• Additional functionality built by teachers

• Full customizable through CSS

cons:

• Understanding all possibilities and functionalities

• Connecting Github and Gitlab to comply with TUD publishing regulations (but possible)

• PDF export suboptimal

• Public from start

• may feel as black box approach (what is under the hood)

Example book made utilizing the template: Linear Algebra

Requirements¶

• Github

optional:

• VSC

  • Extensions

    • Jupyter

    • Markdown

    • Github Actions

    • Python

• Python

  • Dependencies

    • Teachbooks

    • git+https://github.com/TeachBooks/TeachBooks-Favourites

    • sphinx-tudelft-theme

Jupyter Book 2¶

The Jupyter Book 2 template (under development by Freek Pols) is based on the Jupyter Book 2 software and utilizes Microsoft GitHub.

pro’s:

• High quality pdf with ease

• Newest technology, still in development

• Used in science publication

cons:

• Not all functionality from JB1 is available (yet)

• In browser Python is not editable

• Not full control of style

• Public from start if not built locally

Requirements¶

• Github

optional:

• VSC

  • Extensions

    • Jupyter

    • Markdown

    • Github Actions

    • Python

    • MyST-Markdown

• Python

  • Dependencies

    • mystmd

Example book made utilizing the template: Introducing Classical Mechanics & Special Relativity

Which one than?¶

The choice for any of these templates depends on the user. If you want to engage readers with python code which is editable in the browser, don’t choose JB2 (yet). If you also want to make a high quality LaTeX or Typst pdf, go for JB2. If you want to understand the whole JB technology and if you are very keen what to use (dependencies) go for the Jupyter Demo Book. If you are okay with a kind of black box where everything is done already for you, if you have hardly any experience with VSC, git and Python, go for the Teachbooks template. Below summarized: