From d8847e002cfdefbe884f154b672e9d10b24b2915 Mon Sep 17 00:00:00 2001 From: Letian W <32459033+letian-w@users.noreply.github.com> Date: Mon, 20 Nov 2023 12:30:56 -0500 Subject: [PATCH] Update setting-up-tags.md Settings in mkdocs.yml need to be configured for tags.md to be recognized. --- docs/setup/setting-up-tags.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index 8ceaf1273..52d99e63b 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -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: