diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 168b67763..467fddffa 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -515,6 +515,38 @@ In the `navigation` object, `versions` is an array where each entry is an object } ``` +### Default version + +The first version in the `versions` array is used as the default version. Use the `default` field to specify a different version as the default. + +```json +{ + "navigation": { + "versions": [ + { + "version": "1.0.0", + "groups": [ + { + "group": "Getting started", + "pages": ["v1/overview", "v1/quickstart"] + } + ] + }, + { + "version": "2.0.0", + "default": true, + "groups": [ + { + "group": "Getting started", + "pages": ["v2/overview", "v2/quickstart"] + } + ] + } + ] + } +} +``` + ### Version tags Add a badge label to version entries in the version selector dropdown using the optional `tag` field. Use tags to highlight specific versions such as "Latest," "Recommended," or "Beta." diff --git a/organize/settings.mdx b/organize/settings.mdx index 3445eec64..bc8ed45a3 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -559,6 +559,9 @@ This section contains the full reference for the `docs.json` file. Version switcher for sites with multiple [versions](/organize/navigation#versions). + + Set to `true` to make this version the default. If omitted or `false`, the first version in the array is the default. + Badge label displayed next to the version in the version selector. Use to highlight specific versions such as "Latest", "Recommended", or "Beta."