This is a template repository that makes it drop-dead simple for anyone to create a JupyterBook course website and deploy it using GH Pages. No configuration is necessary, there are just three steps.
To access the rendered version of this JupyterBook, visit https://firasm.github.io/jupyterbook_course_template.
Each time there is a commit to master, the website will re-deploy. Currently it takes about 70s for the website to update.
gh-pages
branch is deployed.Support for executing code in a browser using thebe and mybinderorg!
Structured book with markdown file stubs aligning with a course structure for a 13 week course. Fully versioned using GitHub, automatically deployed using GH Actions to either GH or your own server. Can also be extended with a testing framework for extra peace of mind.
Examples of how to use IFrames to embed web content, @phet_sims, @sli.do polls, videos, and other content.
Powerful built-in annotation and commenting features with hypothes.is and utteranc.es. Annotate your syllabus, course readings, and any other content.
Add persistent checkboxes so students can track their progress through notebooks, exercises and readings.
Allow students to download pages of the site in PDF, link to the source code on your repo, or open in a mybinder notebook.
The JupyterBook can be embedded into Canvas using the Redirect tool so students never have to leave their LMS.
There are a few things you need to do to adapt this template for your course. I might miss a few things, so this list is a work in progress:
In the _config.yml
file:
extra_footer
to control License of course materialsIn the _toc.yml
file:
In the about
and class
folders: