Skip to content

Commit 4733123

Browse files
committed
update global anchors
1 parent 4373264 commit 4733123

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

navigation.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,9 @@ In the `navigation` object, `anchors` is an array where each entry is an object
238238
}
239239
```
240240

241-
Anchors that strictly contain external links can be achieved using the `global` keyword:
241+
Use a `global` object for anchors to external links that exist outside your navigation hierarchy. Anchors in a `global` object are particularly useful for linking to resources that are not part of your documentation like a blog or support portal, but should be readily accessible to your users.
242+
243+
Anchors in a `global` object must have an `href` field and cannot direct to a relative path.
242244

243245
```json
244246
{

0 commit comments

Comments
 (0)