diff --git a/README.md b/README.md index 62783e3..e6fe0e2 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,11 @@ The template allows you to start your own Jupyter Book and hosting that book onl ## How to get started +How to use the template is demonstrated in the figure below, followed by a step-by-step tutorial. + +![template-demo](figures/teachbooks-template.gif) +The demonstration is also available as a video [here](https://youtu.be/nN3Oi_MVvF0). + 1. To get started making your Jupyter Book with our functionalities, use the [template book](https://github.com/TeachBooks/template) as template: ```{figure} figures/use_template.png diff --git a/figures/teachbooks-template.gif b/figures/teachbooks-template.gif new file mode 100644 index 0000000..50d6156 Binary files /dev/null and b/figures/teachbooks-template.gif differ diff --git a/requirements.txt b/requirements.txt index 5917367..ebd2a79 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,10 +6,10 @@ teachbooks # depends on jupyter-book docutils==0.17.1 # now list the packages (and the respective url) you wish to download from the GitLab package registry ---extra-index-url https://gitlab.tudelft.nl/api/v4/projects/17983/packages/pypi/simple -jupyterbook_patches ~= 0.1.4 ---extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple -sphinx-thebe ~= 0.9.9 +--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/17983/packages/pypi/simple #temporarily disable +jupyterbook_patches ~= 0.1.4 #temporarily disable +--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple #temporarily disable +sphinx-thebe ~= 0.9.9 #temporarily disable # lastly any packages you wish to download directly from a Git repository -download_link_replacer @ git+https://gitlab.tudelft.nl/mude/sphinx-download-link-replacer +download_link_replacer @ git+https://gitlab.tudelft.nl/mude/sphinx-download-link-replacer #temporarily disable