admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
template/README.md
Tom van Woudenberg 00dcc96f5e Stripped out myst formatting
2024-04-18 10:08:56 +02:00

7.9 KiB
Raw Blame History

Your first TeachBook using the GitHub template

This page shows you how as an example how to start your own Jupyter Book and hosting that book online. 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:

use-template

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

create_new_repository

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

Activate pages

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

GitHub pages as website

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

Action

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

Now that you have your book, you can continue editing your book as described in the other chapters in this book