diff --git a/book/installation-and-setup/figures/Terminal.PNG b/book/installation-and-setup/figures/Terminal.PNG new file mode 100644 index 0000000..d015e08 Binary files /dev/null and b/book/installation-and-setup/figures/Terminal.PNG differ diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index b18f00a..4787010 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -5,28 +5,52 @@ This page is useful for user type 5. ``` -Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. +Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the these features and adds [additional features](/book/features/overview.md). One of those additional features, for example, is the workflow to GitHub Pages. + +Concretely, this means that the teachbooks package can be used to replace the Jupyter book package when calling these features. You could think of it as `jupyter-book` being a dependency of `teachbooks`. + +```{admonition} Note +:class: tip +Don't forget to add the package `teachbooks` in the `requirements.txt` files in your book repository and to have it installed in your working environment (`pip install teachbooks`). +``` ## Build a book As soon as you've installed your book environment with jupyter-book you can build your book locally. The official Jupyter book documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates: +``` +teachbooks build --all +``` +Alternatively: ``` jupyter-book build --all ``` ## View the book locally -Once the build process is completed successfully, you will see the file location in your terminal output. Simply open this in the browser (you may have to copy/paste). +Once the build process is completed successfully, you will see the file location in your terminal output. Your terminal will look something like this. Simply open this in the browser (you may have to copy/paste). + +```{figure} ./figures/Terminal.PNG +--- +width: 80% +name: terminal +align: center +--- +Terminal +``` ```{admonition} Tip :class: tip, dropdown Bookmark the (local) file location for easy access! ``` - (setup-local-server)= ## View the book using a local webserver +```{admonition} Note +:class: tip +If your book consists only of markdown files the local python server is not necessary and you can just view the book locally. +``` + Some features like JupyterLite and Grasple only work when a webserver serves the HTML content for a book. Rather than building the book in your repository and updating the website on the internet, you can use a local webserver to view the book: 1. Make sure you have the TeachBooks Python package installed (e.g., `pip install teachbooks`) 2. Start a server from the command line with: `teachbooks serve`