admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 23:05:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

typos and text fixing

Browse source
This commit is contained in:
Freek Pols 2024-10-18 21:46:42 +02:00
parent 26f79a14a7
commit f718f9f5fc
7 changed files with 24 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

6
book/basic-features/banner.md
View file

@ -10,7 +10,7 @@ name: banner_mude
Example of a banner in the MUDE book.
```
This is a commonly used feature, desribed in the [Jupyter Book manual here](https://jupyterbook.org/en/stable/web/announcements.html). However, note that if you are using the Sphinx-Thebe interactive Python feature, or other features that customize the top part of a Jupyter Book website (for example, the download page buttons), the banner does not always work. In this case, the banner should be specified using the `announcement` option in the `html_theme_options` setting in the `_config.yml` file:
This is a commonly used feature, described in the [Jupyter Book manual here](https://jupyterbook.org/en/stable/web/announcements.html). However, note that if you are using the Sphinx-Thebe interactive Python feature, or other features that customize the top part of a Jupyter Book website (for example, the download page buttons), the banner does not always work. In this case, the banner should be specified using the `announcement` option in the `html_theme_options` setting in the `_config.yml` file:
```
sphinx:
@ -23,9 +23,9 @@ sphinx:
```
```{tip}
Note that you should always enclose your announcement in quotes to make it a complete string. Use a different type of quote if your announcement itself contains them (for example, `"like 'this'"`). If you are using HTML elements, it is best to make your announcement a complete HTML tag, not Markdown with HTML inside.
You should always enclose your announcement in quotes to make it a complete string. Use a different type of quote if your announcement itself contains them (for example, `"like 'this'"`). If you are using HTML elements, it is best to make your announcement a complete HTML tag, not Markdown with HTML inside.
Markdown links do not work in the announcement, in which case you must use HTML!
Markdown links do not work in the announcement, requiring you to use HTML!
```
## Known Issue