diff --git a/README.md b/README.md index fbdd905..ad4a3b6 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This page is useful for user type 3, 4 and 5. ``` -The template allows you to start your own TeachBook and hosting that TeachBook online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. Please look at our manual (https://teachbooks.tudelft.nl/jupyter-book-manual) to find more about that! +The template allows you to start your own TeachBook and hosting that TeachBook online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. Please look at our manual (https://teachbooks.io/manual) to find more about that! ## Features - A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`) @@ -13,7 +13,7 @@ The template allows you to start your own TeachBook and hosting that TeachBook o - A file ready for adding references (`references.bib`, `/book/references.md`) - An example favicon (web browser icon) (`/book/figures/favicon.ico`, `book/_config.yml`.) - An example logo (`/book/figures/TUDelft_logo_rgb.png`, `/book/config.yml`) -- The configuration files set ready to make your Jupyter Notebooks pages work with [live code using our sphinx-thebe extension](https://teachbooks.tudelft.nl/jupyter-book-manual/features/live_code.html) and our recommended settings (`/book/config.yml`) +- The configuration files set ready to make your Jupyter Notebooks pages work with [live code using our sphinx-thebe extension](https://teachbooks.io/manual/features/live_code.html) and our recommended settings (`/book/config.yml`) - An example of setting up preprocessing your table of contents to hide certain draft chapters for eg. students (`_toc.yml`) - A file containing all the recommended software packages (`requirements.txt`) - A file containing the recommended license CC BY 4.0 (`LICENSE.md`) @@ -72,4 +72,4 @@ Set the repository website as your GitHub Pages website under TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here +author: TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here logo: figures/TB_logo.png #add your own logo here execute: @@ -9,7 +9,7 @@ only_build_toc_files: true html: favicon : "figures/TB_favicon.ico" - baseurl : "https://teachbooks.github.io/template/" #Replace this with your own URL + baseurl : "https://teachbooks.io/" #Replace this with your own URL sphinx: config: @@ -19,7 +19,10 @@ sphinx: use_thebe_lite: true exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] html_theme_options: - repository_url: "https://github.com/TeachBooks/template" #add your own repo URL here + repository_url: "https://github.com/user/repo" #add your own repo URL here + path_to_docs: "book" + repository_branch: "main" + use_edit_page_button: true use_repository_button: true use_issues_button : true launch_buttons: diff --git a/book/credits.md b/book/credits.md index c57f07c..ceaeb3c 100644 --- a/book/credits.md +++ b/book/credits.md @@ -17,7 +17,7 @@ We anticipate that the content of this book will change significantly. Therefore ## How the book is made -This book is created using open source tools: it is a Jupyter Book that is written using Markdown, Jupyter notebooks and Python files to generate some figures. The files are stored on a [public GitHub repository](``). The website can be viewed at ``. View the repository README file or contact the authors for additional information. +This book is created using open source tools: it is a JupyterBook that is written using Markdown and Jupyter notebooks. Additional tooling is used from the [TeachBooks initiative](https://teachbooks.io/) to enhance the editing and reading experience. The files are stored on a [public GitHub repository](``). The website can be viewed at ``. View the repository README file or contact the authors for additional information. (editor)= ## About the Editors