Update setting-up-tags.md

Settings in mkdocs.yml need to be configured for tags.md to be recognized.
This commit is contained in:
Letian W 2023-11-20 12:30:56 -05:00 committed by GitHub
parent 15f45bfe6c
commit d8847e002c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -171,6 +171,16 @@ Following is a list of relevant tags:
[TAGS]
```
Then in your `mkdocs.yml` file, add the following.
``` yaml
plugins:
- tags:
tags_file: tags.md
```
Note that the path to `tags.md` is relative to the `docs/` directory.
The `[TAGS]` marker specifies the position of the tags index, i.e. it is
replaced with the actual tags index when the page is rendered. You can include
arbitrary content before and after the marker: