diff --git a/navigation.mdx b/navigation.mdx index 44968d452..c8e9fe3f4 100644 --- a/navigation.mdx +++ b/navigation.mdx @@ -57,7 +57,7 @@ Use groups to organize your sidebar navigation into sections. Groups can be nest alt="" /> -In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon` and `tag` fields are optional. +In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, and `expanded` fields are optional. ```json { @@ -66,6 +66,7 @@ In the `navigation` object, `groups` is an array where each entry is an object t { "group": "Getting started", "icon": "play", + "expanded": false, "pages": [ "quickstart", { @@ -92,6 +93,18 @@ In the `navigation` object, `groups` is an array where each entry is an object t } ``` +### Default expanded state + +Set `expanded: true` on a group to make it expanded by default in the navigation sidebar. This is useful for highlighting important sections or improving discoverability of key content. + +```json +{ + "group": "Getting started", + "expanded": true, + "pages": ["quickstart", "installation"] +} +``` + ## Tabs Tabs create distinct sections of your documentation with separate URL paths. Tabs create a horizontal navigation bar at the top of your documentation that lets users switch between sections.