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
Use this template to quickly start with your own interactive textbook that includes our "standard" selection of features and workflow to host your book on ....github.io/... https://teachbooks.github.io/template/
57 commits 2 branches 0 tags 44 MiB
Find a file
Tom van Woudenberg e0b8f1c863 Update README.md
2024-04-11 09:46:02 +02:00
.github/workflows Update deploy-book-ghpages.yml 2024-04-11 08:16:20 +02:00
book Update intro.md 2024-04-11 08:18:06 +02:00
.gitignore started stripping down risk-and-reliability to create template 2024-02-23 18:02:52 +02:00
LICENSE.md started stripping down risk-and-reliability to create template 2024-02-23 18:02:52 +02:00
README.md Update README.md 2024-04-11 09:46:02 +02:00
requirements.txt [Feature] Use PyPI version of teachbooks 2024-04-04 15:18:29 +02:00

README.md

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 GitHub Actions documentation and our deployment pipeline configuration file .github/workflows/deploy-book-ghpages.yml here.