diff --git a/README.md b/README.md index 461300f..ae13140 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,9 @@ 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.io/manual) to find more about that! +[![call-deploy-book](https://github.com/TeachBooks/template/actions/workflows/call-deploy-book.yml/badge.svg)](https://github.com/TeachBooks/template/actions/workflows/call-deploy-book.yml) -## Features -- A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`) -- An empty TeachBook containing an intro page on root, an example markdown page, an example jupyter notebook page, an example references page. and an example credits page. (`/book/_toc.yml`, `/book/_config.yml`, `/book/credits.md`, `/book/intro.md`, `/book/references.md`, `/book/some_content/overview.md`, `/book/some_content/text_and_code.ipynb`) -- 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.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`) -- Our [GitHub workflow for publishing your TeachBook to GitHub Pages](https://github.com/TeachBooks/deploy-book-workflow) (`.github/workflow/call-deploy-book.yml`) -- A gitignore file containing standard python filetype to ignore (`.gitignore`) -- A readme containing information how to use the template, which can adjusted after using the template (`README.md`) +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! ## How to get started @@ -71,5 +59,19 @@ Set the repository website as your GitHub Pages website under TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here -logo: figures/TB_logo.png #add your own logo here execute: execute_notebooks: "off" @@ -19,6 +18,10 @@ sphinx: use_thebe_lite: true exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] html_theme_options: + logo: + text: Template + image_light: TeachBooks_logo.svg # Put your logo for the light mode here (can be the same as image_dark) + image_dark: TeachBooks_logo_inverted.svg # Put your logo for the dark mode here (can be the same as image_light) repository_url: "https://github.com/user/repo" #add your own repo URL here path_to_docs: "book" repository_branch: "main" @@ -29,6 +32,11 @@ sphinx: thebe: true html_show_copyright: false html_last_updated_fmt: '%B %-d, %Y' + html_static_path: ["figures"] # add folders that contain files that need to be included, such as the location of the logo(s) + mathjax3_config: + chtml: { + mtextInheritFont: true # To typeset text within math prettier + } extra_extensions: - sphinx.ext.imgconverter - jupyterbook_patches diff --git a/book/figures/TB_logo.png b/book/figures/TB_logo.png deleted file mode 100644 index 976df66..0000000 Binary files a/book/figures/TB_logo.png and /dev/null differ diff --git a/book/figures/TeachBooks_logo.svg b/book/figures/TeachBooks_logo.svg new file mode 100644 index 0000000..7f59513 --- /dev/null +++ b/book/figures/TeachBooks_logo.svg @@ -0,0 +1,80 @@ + + + + + + + + + + \ No newline at end of file diff --git a/book/figures/TeachBooks_logo_inverted.svg b/book/figures/TeachBooks_logo_inverted.svg new file mode 100644 index 0000000..dd9bc38 --- /dev/null +++ b/book/figures/TeachBooks_logo_inverted.svg @@ -0,0 +1,81 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file