Skip to content

Commit 1b383f6

Browse files
authored
Update navigation.md with cross_links docs (#1208)
* Update navigation.md with cross_links docs This adds documentation on the cross_links directive in docset.yml files. * Update navigation.md
1 parent e71b76a commit 1b383f6

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/configure/content-set/navigation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,25 @@ external_hosts:
5959
- github.com
6060
```
6161

62+
### `cross_links`
63+
64+
Defines repositories that contain documentation sets you want to link to. The purpose of this feature is to avoid using absolute links that require time-consuming crawling and checking.
65+
66+
Consider a docset repository called `bazinga`. The following example adds three docset repositories to its `docset.yml` file:
67+
68+
```yaml
69+
cross_links:
70+
- apm-server
71+
- cloud
72+
- docs-content
73+
```
74+
75+
To link to a document in the `docs-content` repository, you would write the link as follows:
76+
77+
```
78+
[Link to docs-content doc](docs-content://directory/another-directory/file.md)
79+
```
80+
6281
### `exclude`
6382

6483
Files to exclude from the TOC. Supports glob patterns.

0 commit comments

Comments
 (0)