admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
manual_teachbooks/book/workflows/github.md
Tom van Woudenberg ca068b8262 Update github.md
2024-02-29 10:13:26 +01:00

1.3 KiB
Raw Blame History

GitHub template

To get started making your Jupyter Book with our functionalities, fork our template book https://github.com/PSOR-Books/template :

alt text

Fill in a repository name, this name will be used in the future url of your book:

alt text

Set up the build of your website using GitHub pages by selecting under Settings - Pages - Build and deployment - Source - GitHub Actions:

alt text

Enable the predefined workflow to publish your book under Actions - I understand my workflows, go ahead an enable them:

alt text

Edit a file under Code - book - A file of your choice - Edit in place, in the example below book/intro.md is edited:

alt text

Make your edit and Commit changes to main branch:

alt text alt text

Wait a few minutes for the website to be deployed, if you're curious, have a look at the progress under Actions - All wokflows:

alt text

When the workflow has finished, visit your build book at https://.github.io/<repository_name> (case sensitive). For our example it is: https://dummystudent-Tom.github.io/My_own_book:

alt text