Jupyter Book Template (Cookiecutter Version)

This is Jupyter Book Template built on Cookiecutter. To a non-cookiecutter version of this repo visit the sibling repository. The features are identical, the setup steps might differ.

Check the final result online

Features

These are some of the features of using this template

• Boilerplate CheatSheet of MyST
• Example file for Markdown Notebook and Jupyter Notebook
• Example use of Bibliography
• Automatic deployment of web version and PDF generation (Github Actions)
• Automatic triggering of MyBinder (to speed up live sessions)
• Binder Environment pre-configured for Data Science (Numpy, Pandas, etc.)

Getting Started

Step 1: Set up

To use this template, you need to have a freshly created Github Repo and check the following:

• Create an empty Repository, the default branch will be the develop branch
• Enable Github Actions if disable.
• Enable GithubPages with Source Github Actions Settings > Pages.
• Clone the repo in your local PC.

Step 2: Cut the Cookie

To use this template you need cookiecutter, if you don't know what it is, check the 2 minute introduction by CalmCode. Then install it via pip as:

pip install cookiecutter

Then, to generate your custom project simply run:

cookiecutter https://github.com/ELC/jupyter-book-template-cookiecutter.git

Step 3: Update Repository

Copy the content of the directory generated in the previous step in the cloned repository folder and commit and push as usual.