Jupyter Book Template

This is manual Jupyter Book Template. The manual means there are some parameters you will have to modify by hand after using this repo as a template. For an automatic version, visit the sibling repository built on Cookiecutter. The features are identical, the setup steps might differ.

Check the final result online

Getting Started

Step 1: Fork this Repository

This is a template repository, so you won't use it directly, you will use it a a template for new repositories. Github only allows to use templates you own so you will have to first fork it and follow these steps:

• Fork the repository.
• Make sure you have at least two branches: source and master
• Enable Template Repository in Settings > Options > Template Repository.
• Enable Github Actions if disable.
• Enable GithubPages for the master branch in Settings > Pages.
• Clone the repo in your local PC.

Step 2: Use the Template

Now, when creating a new repository, you should see the template in the dropdown and check "Include all brnaches".

Step 3: Customize

Clone the repo and open the folder with your favourite IDE / Editor and look for the term REPLACE WITH and replace the values with your custom information and remove the brackets. Examples for each are given below:

• Book Title -> Book Template
• Current Year -> 2021
• Project URL -> https://elc.github.com/jupyter-book-template
• Repository URL -> https://github.com/elc/jupyter-book-template
• Binder URL -> https://gke.mybinder.org/build/gh/elc/jupyter-book-template/source
• Google Analytics Tag -> UA-XXXXXXXX-X

Then, some final TODOs:

• Add the public link to the Github Page of the Repo.
• Update Links to relevant Badges in this document.
• Place all static assets (images, videos, etc.) inside the _static folder.
• Check all available features in the Introduction chapter that comes with the book.
• Delete this README and update it with project relevant information.