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/
145 commits 2 branches 0 tags 44 MiB
Find a file
Tom van Woudenberg 64caf4cc7e Merge branch 'main' into manual_description
2024-05-07 15:10:50 +02:00
.github/workflows Update call-deploy-book.yml 2024-04-16 20:43:50 +02:00
book Revert "Added 404 page" 2024-05-07 14:51:48 +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-05-07 15:10:50 +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. You need to activate GitHub pages so that your website is publisehd to the internet. As long as you don't do this your book is not published online. Actually, now that you've taken this template our workflow tries to publish it to GitHub pages, which you didn't have the chance to activate yet. That's why you probably received an email with 'call-deploy-book: Some jobs were not successful' and you see the failed job under Actions - All workflows - call-deploy-book - Initial commit. You can activate GitHub pages by setting the source for GitHub pages to GitHub Actions under Settings - Pages - Build and deployment - Source - GitHub Actions:
:name: activate_pages
  1. Make an edit to the book by editing and committing changes to one of the files in the book/ subdirectory (available under Code). Now checkout the progress of the publishing workflow under Actions - All workflows - call-deploy-book -<the most recent workflow run>. Remember, the first commit which is there has failed because GitHub Pages wasn't activated at the time of Initial commit, you could also re-run that job if you don't want to make an edit. You can do so by running the workflow from Actions - All workflows - call-deploy-book - Initial commit - Re-run jobs - Re-run all jobs - Re-run jobs:
: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's summary as well, as shown in the figure of step 4.

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