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/
139 commits 2 branches 0 tags 44 MiB
Find a file
Tom van Woudenberg ef46c7b2fa Merge branch 'main' into manual_description
2024-05-03 12:30:00 +02:00
.github/workflows Update call-deploy-book.yml 2024-04-16 20:43:50 +02:00
book Update _config.yml 2024-05-02 09:08:50 +02:00
figures Improved description 2024-04-18 10:07:09 +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 Merge branch 'main' into manual_description 2024-04-26 16:31:55 +02:00
requirements.txt [Feature] Use PyPI version of teachbooks 2024-04-04 15:18:29 +02:00

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
  1. Fill in a repository name, this name will be used in the future url of your book:
:name: create_new_repository
  1. Set source for GitHub pages to under Settings - Pages - Build and deployment - Source - GitHub Actions. As long as you don't do this your book is not published online:
:name: activate_pages
  1. Make an edit to the book by editing one of the files in the book/ subdirectory (available under Code) or by running the workflow from Actions - All workflows - call-deploy-book - Run workflow - Run workflow. Wait a few minutes for the website to be deployed, if you're curious, you can see the progress and result under Actions - All workflows - call-deploy-book -<the most recent workflow run> (The first commit might have failed because github pages wasn't activated at the time of Initial commit):
:name: 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 or in the GitHub repository website which you set in step 3.

Additional tip: Set the repository website as your GitHub Pages website under Code- About - - Website - Use your GitHub Pages Website

:name: github_pages_as_website