Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jérome Perrin
gitlab-ce
Commits
43dea824
Commit
43dea824
authored
Aug 18, 2017
by
Marcia Ramos
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
use inline links instead of referenced
parent
11661c2a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
6 additions
and
7 deletions
+6
-7
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+6
-7
No files found.
doc/development/doc_styleguide.md
View file @
43dea824
...
...
@@ -113,13 +113,12 @@ merge request.
## Links
-
If a link makes the paragraph to span across multiple lines, do not use
the regular Markdown approach:
`[Text](https://example.com)`
. Instead use
`[Text][identifier]`
and at the very bottom of the document add:
`[identifier]: https://example.com`
. This is another way to create Markdown
links which keeps the document clear and concise. Bonus points if you also
add an alternative text:
`[identifier]: https://example.com "Alternative text"`
that appears when hovering your mouse on a link
-
Use the regular inline link markdown markup
`[Text](https://example.com)`
.
It's easier to read, review, and maintain.
-
If there's a link that repeats several times through the same document,
you can use
`[Text][identifier]`
and at the bottom of the section or the
document add:
`[identifier]: https://example.com`
, in which case, we do
encourage you to also add an alternative text:
`[identifier]: https://example.com "Alternative text"`
that appears when hovering your mouse on a link.
### Linking to inline docs
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment