diff --git a/doc/user/markdown.md b/doc/user/markdown.md index d8b3ed3c56af15c38cd4c86b359b8f2d5c89c8d4..779079119d07ae253d1094648bceed8bf530fc98 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -464,13 +464,15 @@ The following paragraphs use HTML to work around a Markdown bug. Do not change it back to a Markdown backticks. For more information, see https://gitlab.com/gitlab-org/gitlab/-/issues/359077. --> +<!-- vale gitlab.Uppercase = NO --> A table of contents is an unordered list that links to subheadings in the document. You can add a table of contents to issues and merge requests, but you can't add one -to notes or comments. Add either the `[[_TOC_]]` or <code>`[TOC]`</code> tag on its own line +to notes or comments. Add either the `[[_TOC_]]` or <code>[TOC]</code> tag on its own line to the **Description** field of any of the supported content types: +<!-- vale gitlab.Uppercase = YES --> NOTE: -A TOC renders also when you use <code>`[TOC]`</code>, regardless of being on its own line or not. +A table of contents renders also when you use <code>`[TOC]`</code>, regardless of being on its own line or not. This behavior is unintended. For more information, see [issue 359077](https://gitlab.com/gitlab-org/gitlab/-/issues/359077). - Markdown files.