Skip to content

Commit 83108bb

Browse files
authored
Update links.md
1 parent 883b7db commit 83108bb

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/syntax/links.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,22 @@ It has two components:
1515

1616
### Internal links
1717

18-
Link between documentation files using either relative or absolute paths.
18+
Use internal links for doc to doc links. Internal links can reference a relative or absolute path, and you can optionally append an anchor to send readers to a specific section on a page.
1919

2020
#### Relative paths
21-
Navigate relative to the current file's location:
2221

2322
```markdown
24-
[Security documentation](../security/index.md)
23+
[Security docs](../security/index.md)
2524

26-
[Monitoring guide](monitor/index.md)
27-
```
25+
[Install](monitor/index.md#installation)
26+
````
2827

2928
#### Absolute paths
3029

31-
You can also use absolute paths to link to pages within the same repository.
32-
Say you're working on a random page somewhere in the `docs-content` repo. You can link to a page in the `deploy-manage` section like this:
33-
3430
```markdown
35-
[API Keys](/deploy-manage/api-keys.md)
31+
[API keys](/deploy-manage/api-keys.md)
32+
33+
[Authentication](/deploy-manage/api-keys.md#authentication)
3634
```
3735

3836
Note the leading `/` before the path.

0 commit comments

Comments
 (0)