diff --git a/book/features/external_toc.md b/book/features/external_toc.md index 940f918..7e70b36 100644 --- a/book/features/external_toc.md +++ b/book/features/external_toc.md @@ -6,7 +6,7 @@ This page is useful for user type 3-5. ``` -{bdg-secondary}`Python Package` +{bdg-secondary}`Python Package: teachbooks` ## Introduction When creating books, you might want to reuse material from other people or from other books you made. In some cases you might even want to have the exact same material into your book. You could do so by manually copying material over. However, whenever the source material is updated, you have to do that again. As an alternative, you can use the underlying git system to refer to the source file directly. This allows you to pick a specific version, or keep the most up-to-date version of it. This pages explains how to do so directly in the table of contents using the TeachBooks package. diff --git a/book/features/local_server.md b/book/features/local_server.md index cea8930..cc7760c 100644 --- a/book/features/local_server.md +++ b/book/features/local_server.md @@ -6,7 +6,7 @@ This section is useful for user type 4-5. ``` -{bdg-secondary}`Python Package` +{bdg-secondary}`Python Package: teachbooks` Perhaps you have already noticed that when building a book and testing it locally on your computer, some features do not work the way you expect, or worse---do not work at all! This is because many interactive features rely on browser functionality to work properly, for example: Grasple/H5p iframe exercises, Sphinx-Thebe Python interactivity and HTML/Javascript elements. Although the website is _static_ (i.e., there is no code running on a webserver that generates the content), modern web browsers have their own internal computing environments that run processes to deliver the rich content we desire in our books. diff --git a/book/features/overview.md b/book/features/overview.md index 7ad3782..4a6cd20 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -9,11 +9,11 @@ Since the list of TeachBook features is getting quite long, we have grouped them - Book styling - TeachBooks student-view features -Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features: +Additionally, not all features are built and shared in the same way. We do our best to make sure that as many tools as possible are included automatically when using our TeachBooks Template Book; if you are not using the Template, we try to make sure each of our tools can be used independently. For transparency, tags will help differentiate between the different backgrounds of the features: - {bdg-warning}`Javascript overlay` - {bdg-success}`Chrome Extension` - {bdg-white}`GitHub App and Javascript script` -- {bdg-secondary}`Python Package` +- {bdg-secondary}`Python Package: teachbooks` - {bdg-light}`GitHub Reusable Action` - {bdg-light}`GitHub Template` - {bdg-dark}`Git Workflow` diff --git a/book/features/teachbooks.md b/book/features/teachbooks.md index 4caf9a8..e182063 100644 --- a/book/features/teachbooks.md +++ b/book/features/teachbooks.md @@ -6,7 +6,7 @@ This page is useful for all users to understand how the book building process works and can be influenced, although the implementation is likely going to be carried out by User Types 3, 4 or 5. ``` -{bdg-secondary}`Python Package` +{bdg-secondary}`Python Package: teachbooks` The package is a CLI tool that primarily provides a wrapper around the Jupyter Book package which is used for pre- and postprocessing. In this case "wrapper" refers to the CLI usage: CLI commands generally invoke `jupyter-book` commands internally; the `jupyter-book` package is _not_ distributed within the `teachbooks` package.