admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

automatic indexing

Browse source
This commit is contained in:
Katia Gatt 2025-08-11 22:02:58 +02:00
parent 11e56e836e
commit f5d17483f5
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
book/exercises/007.md
View file

@ -47,7 +47,16 @@ Can you install and use a new Sphinx extension like `Sphinx-Indexed-Definitions`
This will appear as a hyperlink that takes the reader directly to the definition.
7. The same steps you followed here can be used to install any other extension of your choice. Simply add the extension to your `requirements.txt` (using either a GitHub link or PyPI package name), and list it under `extra_extensions` in `_config.yml`. Then use its features in your Markdown files according to the extension’s documentation. Check out the ever-growing list of TeachBooks extensions in the [TeachBooks manual](https://teachbooks.io/manual/features/overview.html)!
7. The extension can also automatically index terms based on text formatting. In another `.md` file, try writing:
```md
This is a **strong term**, this is an *emphasised term*, and this is a `literal term`.
```
When the book is built, these terms will be included in the generated index without needing to define them manually. You can view the index in the build output to confirm.
8. The same steps you followed here can be used to install any other extension of your choice. Simply add the extension to your `requirements.txt` (using either a GitHub link or PyPI package name), and list it under `extra_extensions` in `_config.yml`. Then use its features in your Markdown files according to the extension’s documentation. Check out the ever-growing list of TeachBooks extensions in the [TeachBooks manual](https://teachbooks.io/manual/features/overview.html)!
8. When you are ready, commit your changes to the repository by clicking on the green `Commit changes` button.