Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-01-15 03:09:05 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-01-15 03:09:05 +0300
commitc9bd888d38746a9bb73629681d8c393c3ec77275 (patch)
tree776e4a8cff1dc6b407c39189040ec0e556aa312c /doc/user/markdown.md
parent0b12a5312c9701fbfed25fbb334d47900ced736b (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/markdown.md')
-rw-r--r--doc/user/markdown.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md
index 2d7b9e17a40..9aa1849869b 100644
--- a/doc/user/markdown.md
+++ b/doc/user/markdown.md
@@ -773,17 +773,29 @@ do*this*and*do*that*and*another thing
### Footnotes
-Footnotes add a link to a note rendered at the end of a Markdown file:
+Footnotes add a link to a note that will be rendered at the end of a Markdown file.
+
+To make a footnote, you need both a reference tag and a separate line (anywhere in the file) with the note content.
+
+Regardless of the tag names, the relative order of the reference tags determines the rendered numbering.
```markdown
-You can add footnotes to your text as follows.[^1]
+A footnote reference tag looks like this:[^1]
+
+[^1]: This is the contents of a footnote.
-[^1]: This is my awesome footnote (later in file).
+Reference tags can use letters and other characters.[^footnote-note]
+
+[^footnote-note]: Avoid using lowercase `w` or an underscore (`_`) in your tag name until until an [upstream bug](https://gitlab.com/gitlab-org/gitlab/issues/24423) is resolved.
```
-You can add footnotes to your text as follows.[^1]
+A footnote reference tag looks like this:[^1]
+
+[^1]: This is the contents of a footnote.
+
+Reference tags can use letters and other characters.[^footnote-note]
-[^1]: This is my awesome footnote (later in file).
+[^footnote-note]: Avoid using lowercase `w` or an underscore (`_`) in your tag name until until an [upstream bug](https://gitlab.com/gitlab-org/gitlab/issues/24423) is resolved.
### Headers