You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configure/content-set/navigation.md
+27-1Lines changed: 27 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,12 +72,38 @@ cross_links:
72
72
- docs-content
73
73
```
74
74
75
+
#### Adding cross-links in Markdown content
76
+
75
77
To link to a document in the `docs-content` repository, you would write the link as follows:
76
78
77
-
```
79
+
```markdown
78
80
[Link to docs-content doc](docs-content://directory/another-directory/file.md)
79
81
```
80
82
83
+
You can also link to specific anchors within the document:
84
+
85
+
```markdown
86
+
[Link to specific section](docs-content://directory/file.md#section-id)
87
+
```
88
+
89
+
#### Adding cross-links in navigation
90
+
91
+
Cross-links can also be included in navigation structures. When creating a `toc.yml` file or defining navigation in `docset.yml`, you can add cross-links as follows:
92
+
93
+
```yaml
94
+
toc:
95
+
- file: index.md
96
+
- title: External Documentation
97
+
cross_link: docs-content://directory/file.md
98
+
- folder: local-section
99
+
children:
100
+
- file: index.md
101
+
- title: API Reference
102
+
cross_link: elasticsearch://api/index.html
103
+
```
104
+
105
+
Cross-links in navigation will be automatically resolved during the build process, maintaining consistent linking between related documentation across repositories.
106
+
81
107
### `exclude`
82
108
83
109
Files to exclude from the TOC. Supports glob patterns.
0 commit comments