Skip to content
代码片段 群组 项目
提交 501b8786 编辑于 作者: Achilleas Pipinellis's avatar Achilleas Pipinellis
浏览文件

Add section about inline links

上级 f6bb5eaa
No related branches found
No related tags found
无相关合并请求
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
# For a list of all options, see https://vale.sh/docs/topics/styles/ # For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence extends: existence
message: "Put this link inline with the rest of the text." message: "Put this link inline with the rest of the text."
link: https://docs.gitlab.com/ee/development/documentation/styleguide/#links link: https://docs.gitlab.com/ee/development/documentation/styleguide/#inline-links
vocab: false vocab: false
level: error level: error
nonword: true nonword: true
......
...@@ -847,6 +847,26 @@ However, you should avoid putting too many links on any page. Too many links can ...@@ -847,6 +847,26 @@ However, you should avoid putting too many links on any page. Too many links can
- Consider using [Related topics](../topic_types/_index.md#related-topics) to reduce links that interrupt the flow of a task. - Consider using [Related topics](../topic_types/_index.md#related-topics) to reduce links that interrupt the flow of a task.
- Try to avoid anchor links to sections on the same page. Let users rely on the right navigation instead. - Try to avoid anchor links to sections on the same page. Let users rely on the right navigation instead.
### Inline links
Use inline links instead of reference links. Inline links are easier to parse
and edit.
([Vale](../testing/vale.md) rule: [`ReferenceLinks.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab_docs/ReferenceLinks.yml))
- Do:
```markdown
For more information, see [merge requests](path/to/merge_requests.md)
```
- Don't:
```markdown
For more information, see [merge requests][1].
[1]: path/to/merge_requests.md
```
### Links in the same repository ### Links in the same repository
To link to another documentation (`.md`) file in the same repository: To link to another documentation (`.md`) file in the same repository:
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册