template/README.md

Your first TeachBook using the GitHub template

:class: tip
This page is useful for user type 3, 4 and 5.

The template allows you to start your own Jupyter Book and hosting that book online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book.

1. To get started making your Jupyter Book with our functionalities, use the template book as template:

:name: use-template

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

:name: create_new_repository

3. Set source for GitHub pages to under Settings - Pages - Build and deployment - Source - GitHub Actions:

:name: activate_pages

4. Set repository website as your GitHub Pages website under Code- About - - Website - Use your GitHub Pages Website

:name: github_pages_as_website

4. Wait a few minutes for the website to be deployed, if you're curious, have a look at the progress under Actions - All workflows - call-deploy-book -specific workflow run:

:name: action

5. When the workflow has finished, visit your build book at https://<username or organiszation_name>.github.io/<repository_name> (case sensitive). For our example it is https://dummydocent.github.io/test_book_from_template/ for the shown repository. These links are visible in the action as well, as shown in the figure above or in the GitHub repository website which you set in step 3.