diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-06 18:08:14 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-06 18:08:14 +0300 |
| commit | b72b14cb4d1567c555d9e5cb336111afd479ee9e (patch) | |
| tree | 7cc3087bae34b9dd9ce2339658d299cb4dae0ed9 /doc/user/markdown.md | |
| parent | d5e68dfae835516bcc94d208cd7be461e75831ff (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/markdown.md')
| -rw-r--r-- | doc/user/markdown.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 2966c35e771..fc278007463 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -412,6 +412,10 @@ A table of contents is an unordered list that links to subheadings in the docume To add a table of contents to a Markdown file, wiki page, issue request, or merge request description, add the `[[_TOC_]]` tag on its own line. +NOTE: +You can add a table of contents to issues and merge requests, but you can't add one +to notes or comments. + ```markdown This is an intro sentence to my Wiki page. @@ -507,8 +511,8 @@ This example links to `<wiki_root>/miscellaneous.md`: GitLab Flavored Markdown renders GitLab-specific references. For example, you can reference an issue, a commit, a team member, or even an entire project team. GitLab Flavored Markdown turns -that reference into a link so you can navigate between them. All references to namespaces or -projects must use lower-case characters. +that reference into a link so you can navigate between them. All references to projects should use the +**project slug** rather than the project name. Additionally, GitLab Flavored Markdown recognizes certain cross-project references and also has a shorthand version to reference other projects from the same namespace. @@ -520,7 +524,7 @@ GitLab Flavored Markdown recognizes the following: | specific user | `@user_name` | | | | specific group | `@group_name` | | | | entire team | `@all` | | | -| project | `namespace/project>` | | | +| project | `namespace/project` | | | | issue | ``#123`` | `namespace/project#123` | `project#123` | | merge request | `!123` | `namespace/project!123` | `project!123` | | snippet | `$123` | `namespace/project$123` | `project$123` | |