Skip to content

Update navigation.md with cross_links docs #1208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 2, 2025
Merged

Update navigation.md with cross_links docs #1208

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d428631
Update navigation.md with cross_links docs
theletterf May 2, 2025
15c4cf5
Update navigation.md
theletterf May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/configure/content-set/navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,25 @@ external_hosts:
- github.com
```

### `cross_links`

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.

Consider a docset repository called `bazinga`. The following example adds three docset repositories to its `docset.yml` file:

```yaml
cross_links:
- apm-server
- cloud
- docs-content
```

To link to a document in the `docs-content` repository, you would write the link as follows:

```
[Link to docs-content doc](docs-content://directory/another-directory/file.md)
```

### `exclude`

Files to exclude from the TOC. Supports glob patterns.
Expand Down
Loading