mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-12 22:35:51 +00:00
45 lines
2.1 KiB
Markdown
45 lines
2.1 KiB
Markdown
# GitHub template
|
|
|
|
To get started making your Jupyter Book with our functionalities, fork our template book https://github.com/TeachBooks/template :
|
|
|
|
|
|
|
|
Fill in a repository name, this name will be used in the future url of your book:
|
|
|
|
|
|
|
|
Set up the build of your website using GitHub pages by selecting under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`:
|
|
|
|
|
|
|
|
Enable the predefined workflow to publish your book under `Actions` - `I understand my workflows, go ahead an enable them`:
|
|
|
|
|
|
|
|
Edit a file under `Code` - `book` - A file of your choice - `Edit in place`, in the example below `book/intro.md` is edited:
|
|
|
|
|
|
|
|
Make your edit and `Commit changes` to `main` branch:
|
|
|
|
|
|
|
|
|
|
Wait a few minutes for the website to be deployed, if you're curious, have a look at the progress under `Actions` - `All wokflows`:
|
|
|
|
|
|
|
|
When the workflow has finished, visit your build book at `https://<username>.github.io/<repository_name>` (case sensitive). For our example it is: [https://dummystudent-Tom.github.io/My_own_book](https://dummystudent-Tom.github.io/My_own_book) :
|
|
|
|
|
|
|
|
---
|
|
|
|
It is possible to have multiple versions of a book published at once, by creating another Git branch (e.g. `draft` or `dev`).
|
|
For each branch, the respective book is published at `https://<username>.github.io/<bookname>/<branchname>`.
|
|
Technical note: for convenience, just `.../<bookname>/` redirects to `.../<bookname>/book/`, which is itself an alias (a symlink) for
|
|
`.../<bookname>/main/`.
|
|
|
|
To learn more about how we do this, please see the [GitHub Actions documentation](https://docs.github.com/en/actions) and our deployment pipeline configuration file `.github/workflows/deploy-book-ghpages.yml` [here](https://github.com/TeachBooks/template/blob/main/.github/workflows/deploy-book-ghpages.yml).
|
|
|
|
|