Skip to content

Commit c3da9c8

Browse files
authored
Update links.md to add reference-style links
This adds a section on reference-style links to the docs.
1 parent df31b39 commit c3da9c8

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/syntax/links.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# Links
22

3-
A markdown link looks like this:
3+
A Markdown link looks like this:
44

55
```markdown
66
[Link text](destination.md)
77
```
8+
89
It has two components:
10+
911
- Link **text** enclosed in square brackets `[ ]`
1012
- Link **destination** enclosed in parentheses `( )`
1113

@@ -133,6 +135,22 @@ You can also auto-generate text for specific headings within files:
133135
<!-- Uses the "Configuration" section title from current file -->
134136
```
135137

138+
## Reference-style links
139+
140+
`docs-builder` supports reference-style links. For example:
141+
142+
```markdown
143+
- [Link]
144+
- [Your own text][Link2]
145+
146+
... Botton of the page ...
147+
148+
[Link]: http://some.site
149+
[Link2]: http://some.other.site
150+
```
151+
152+
Reference style links are useful when adding links to tables, for example, or to update frequently used links more easily.
153+
136154
## Legacy features
137155

138156
### Inline anchors

0 commit comments

Comments
 (0)