diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 3f9a0d94b..fd9d6beee 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -58,7 +58,7 @@ Use groups to organize your sidebar navigation into sections. Groups can be nest alt="Decorative graphic of groups." /> -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. +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`, `expanded`, `root`, and `public` fields are optional. ```json { @@ -119,6 +119,36 @@ Use the `expanded` property to control the default state of a nested group in th } ``` +### Root page + +Use the `root` property to specify a landing page for a group. When users click on the group name, they will navigate to this page. + +```json +{ + "group": "API Reference", + "root": "api/overview", + "pages": [ + "api/authentication", + "api/endpoints" + ] +} +``` + +### Public groups + +Use the `public` property to mark a group as publicly accessible. This is useful for documentation that should be visible to all users, even those who are not authenticated. + +```json +{ + "group": "Public Documentation", + "public": true, + "pages": [ + "public/overview", + "public/getting-started" + ] +} +``` + ## 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. diff --git a/organize/settings.mdx b/organize/settings.mdx index d1e1d7dbb..7dd99511c 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -304,7 +304,7 @@ This section contains the full reference for the `docs.json` file. Default theme mode. Choose `system` to match users' OS settings, or `light` or `dark` to force a specific mode. Defaults to `system`. - Whether to hide the light/dark mode toggle. Defaults to `true`. + Whether to hide the light/dark mode toggle. Defaults to `false`. @@ -612,8 +612,8 @@ This section contains the full reference for the `docs.json` file. Site-wide banner displayed at the top of pages. - - The content of the banner. Supports plain text and Markdown formatting. For example: + + The text content displayed in the banner. Supports basic MDX formatting including links, bold, and italic text. Custom components are not supported. For example: ```json { @@ -622,7 +622,7 @@ This section contains the full reference for the `docs.json` file. ``` - Whether users can dismiss the banner. Defaults to `false`. + Whether to show the dismiss button on the right side of the banner. Defaults to `false`. @@ -643,13 +643,44 @@ This section contains the full reference for the `docs.json` file. + + Glob patterns specifying additional locations where snippet files can be placed. The default `/snippets/` folder is always included. + + ```json + { + "snippets": [ + "components/**/*.mdx", + "shared/snippets/**/*.mdx" + ] + } + ``` + + + + Feedback options presented to viewers. + + + + Whether to enable thumbs up/down feedback on pages. + + + Whether to enable edit suggestions feedback. + + + Whether to enable issue reporting feedback. + + + + Contextual menu for AI-optimized content and integrations. - + Actions available in the contextual menu. The first option appears as the default. + **Built-in options:** + - `copy`: Copy the current page as Markdown to the clipboard. - `view`: View the current page as Markdown in a new tab. - `chatgpt`: Send the current page content to ChatGPT. @@ -659,6 +690,30 @@ This section contains the full reference for the `docs.json` file. - `cursor`: Installs your hosted MCP server in Cursor. - `vscode`: Installs your hosted MCP server in VSCode. + **Custom options:** + + You can also define custom contextual menu options as objects with the following properties: + + + + Display title for the custom option. + + + Description text for the custom option. + + + Icon for the custom option. Supports icon library names, URLs, paths, or SVG code. + + + Link destination for the custom option. Can be a simple URL string or an object with `base` and optional `query` parameters. + + Special preset values: + - `$page`: Current page content + - `$path`: Current page path + - `$mcp`: MCP server URL + + + Contextual Menu + + Microsoft Clarity integration. + + + + Your Microsoft Clarity project ID. + + + Clearbit data enrichment integration. @@ -882,6 +946,18 @@ This section contains the full reference for the `docs.json` file. + + Hightouch integration. + + + + Your Hightouch write key. + + + Your Hightouch API host. + + + Hotjar integration. @@ -905,6 +981,17 @@ This section contains the full reference for the `docs.json` file. + + Koala integration. + + + + Your Koala public API key. + + Minimum length: 2 + + + LogRocket integration. @@ -953,9 +1040,6 @@ This section contains the full reference for the `docs.json` file. Your PostHog API host. - - Enable or disable session recording. - @@ -1018,13 +1102,13 @@ This section contains the full reference for the `docs.json` file. - Whether to automatically redirect to the home page when a page is not found. + Whether to automatically redirect to the home page when a page is not found. Defaults to `true`. Custom title for the 404 error page. - Custom description for the 404 error page. Supports Markdown formatting. + Custom description for the 404 error page. Supports basic MDX formatting including links, bold, and italic text. Custom components are not supported.