diff --git a/book/_config.yml b/book/_config.yml index 8841b2d..36b9bb6 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,6 +1,7 @@ title: How to make a TeachBook -author: Tom van Woudenberg, Robert Lanzafame, Max Ramgraber, Caspar Jungbacker, Julie Kirsch -logo: images/TUDelft_logo_rgb.png +author: TU Delft TeachBooks Team, built with Jupyter Book +logo: images/Logo_without_background.png +copyright: Delft University of Technology, CC BY 4.0 execute: execute_notebooks: 'off' diff --git a/book/basic-features/overview.md b/book/basic-features/overview.md index 7f650d4..7c3975f 100644 --- a/book/basic-features/overview.md +++ b/book/basic-features/overview.md @@ -7,7 +7,7 @@ This section is useful for user type 3-6. ```{warning} Under Construction! -This page will provide a list of some commonly used book features which are all available in the original jupyter book package. However, this page includes best-practises on how to use them. +This page will provide a list of some commonly used book features which are all available in the original Jupyter book package. However, this page includes best-practises on how to use them. ``` Things to include somewhere: diff --git a/book/images/Logo_without_background.png b/book/images/Logo_without_background.png new file mode 100644 index 0000000..83bbb68 Binary files /dev/null and b/book/images/Logo_without_background.png differ diff --git a/book/images/logo-wide.svg b/book/images/logo-wide.svg new file mode 100644 index 0000000..e29f7ed --- /dev/null +++ b/book/images/logo-wide.svg @@ -0,0 +1 @@ +logo-wide diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index 9f134ea..2392e6f 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -5,11 +5,11 @@ 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. ## 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](https://jupyterbook.org/en/stable/basics/build.html) 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: +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: ``` jupyter-book build --all diff --git a/book/intro.md b/book/intro.md index cdfcee1..7fbd550 100644 --- a/book/intro.md +++ b/book/intro.md @@ -1,6 +1,6 @@ # TeachBooks Manual -This is an introduction to Git, VS Code and Jupyter Books for teachers and teaching assistants involved in TeachBooks. This book is still work in progress, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! For more information about teachbooks, visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/). +This is an introduction to Git, VS Code and Jupyter Books for teachers and teaching assistants involved in TeachBooks, our platform easing the process off making a Jupyter book. This book is still work in progress, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! For more information about teachbooks, visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/). ## Contact -If you encounter any issues, please contact Tom van Woudenberg, Robert Lanzafame or one of our TAs Caspar Jungbacker or Julie Kirsch at TeachBooks@tudelft.nl. \ No newline at end of file +If you encounter any issues, please contact Tom van Woudenberg, Robert Lanzafame or one of our TAs Julie Kirsch at TeachBooks@tudelft.nl. \ No newline at end of file