diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-11-22 21:10:41 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-11-22 21:10:41 +0300 |
commit | 6f6c75ed62ddfca08cc1c03920fb82dc283cb072 (patch) | |
tree | cbed71face48598c4af8603d79a46c6806f6a34b /doc/development/documentation/styleguide | |
parent | 51ad17b4112ce677613ed2af7f8b742fe2ba2afe (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r-- | doc/development/documentation/styleguide/index.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 6158d60a0ba..a23552f5d77 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -754,8 +754,20 @@ Instead, follow the [API topic template](../restful_api_styleguide.md#api-topic- ### Footnotes -To indicate a footnote, use the HTML tag `<sup>` with a number. -Put the tag at the end of the sentence or term. For example: +Use footnotes below tables when it's not suitable to include the content in the table +itself. For example, use footnotes when you need to: + +- Provide the same reference information on several table cells. +- Include content that would disrupt the table's layout. + +#### Footnote format + +For each footnote, use the HTML superscript tag `<sup>`. +Put the tag at the end of the sentence or term. + +When you add a footnote, do not re-sort the existing tags in the table. + +For example: ```markdown | App name | Description | |