https://github.com/elc/jupyter-book-template
Template Repo for building Jupyter Books
https://github.com/elc/jupyter-book-template
book data-science jupyter jupyter-book jupyter-notebooks template
Last synced: about 1 year ago
JSON representation
Template Repo for building Jupyter Books
- Host: GitHub
- URL: https://github.com/elc/jupyter-book-template
- Owner: ELC
- License: mit
- Archived: true
- Created: 2021-07-31T01:03:09.000Z (almost 5 years ago)
- Default Branch: source
- Last Pushed: 2021-08-03T23:06:10.000Z (almost 5 years ago)
- Last Synced: 2025-02-25T19:26:05.083Z (over 1 year ago)
- Topics: book, data-science, jupyter, jupyter-book, jupyter-notebooks, template
- Language: Jupyter Notebook
- Homepage: https://elc.github.io/jupyter-book-template/
- Size: 1.54 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jupyter Book Template
[](https://elc.github.io/jupyter-book-template/)
[](https://mybinder.org/v2/gh/elc/jupyter-book-template/HEAD)
[](https://colab.research.google.com/github/ELC/jupyter-book-template/blob/source/chapters/00_how_to_use.ipynb)
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](https://github.com/ELC/jupyter-book-template-cookiecutter) built on Cookiecutter. The features are identical, the setup steps might differ.
Check the final result [online](https://elc.github.io/jupyter-book-template/)
## 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.