Skip to content

Commit db62963

Browse files
authored
Update links.md
1 parent 864cd44 commit db62963

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/syntax/links.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ It has two components:
1515

1616
### Internal links
1717

18-
Link to other documentation pages using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages.
18+
Link to other documentation pages in the same repository using the file’s relative or absolute path. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages.
1919

2020
#### Relative paths
2121

22+
Use relative paths to link to other pages inside the same repository.
23+
2224
```markdown
2325
[Security docs](../security/index.md)
2426

@@ -27,6 +29,8 @@ Link to other documentation pages using the file’s relative or absolute path.
2729

2830
#### Absolute paths
2931

32+
Use absolute paths to link to other pages inside the same repository.
33+
3034
```markdown
3135
[API keys](/deploy-manage/api-keys.md)
3236

@@ -88,6 +92,8 @@ The syntax follows the format `<scheme>://<path>`, where:
8892
The `path` in cross-repo links must be relative to the `docset.yml` file and not the full path within the repo
8993
:::
9094

95+
Never use a full URL for links across documentation repositories.
96+
9197
### External links
9298

9399
Link to websites and resources outside the Elastic docs:

0 commit comments

Comments
 (0)