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 3f0877f32e
Update README.md
2024-04-16 19:54:04 +02:00

8.2 KiB
Raw Blame History

Template

This is the template book. You can use this book as a template to start your own TeachBook in as easy-as-possible a way.

Steps to use this template and publish it online

  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:

action

  1. When the workflow has finished, visit your build book at https://<username>.github.io/<repository_name> (case sensitive). For our example it is https://dummydocent.github.io/test_book_from_template/ for the shown repository.

To learn more about how we do this, please see the =our deployment pipeline configuration file .github/workflows/deploy-book-ghpages.yml here in it's repository and GitHub Actions documentation .