mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-12 22:35:51 +00:00
Merge branch 'add-docs-github-multiple-branches' into 'main'
Add docs on GitHub multiple branches See merge request interactivetextbooks-citg/jupyter-book-manual!45
This commit is contained in:
commit
fd373ab80f
3 changed files with 15 additions and 3 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -133,4 +133,5 @@ _build/
|
|||
_contents/
|
||||
|
||||
# Jupyterlite
|
||||
_output/
|
||||
_output/
|
||||
book/.jupyterlite.doit.db
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -29,6 +29,17 @@ Wait a few minutes for the website to be deployed, if you're curious, have a loo
|
|||
|
||||

|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
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).
|
||||
|
||||
|
||||

|
||||
Loading…
Add table
Add a link
Reference in a new issue