diff --git a/settings.mdx b/settings.mdx index e71b345f1..2836f68a2 100644 --- a/settings.mdx +++ b/settings.mdx @@ -25,7 +25,7 @@ For the best editing experience, include the schema reference at the top of your }, "navigation": { // Your navigation structure - }, + } // The rest of your configuration } ``` @@ -39,9 +39,10 @@ This section contains the full reference for the `docs.json` file. The layout theme of your site. - One of the following: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`. - - See [Themes](themes) for more information. +One of the following: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`. + +See [Themes](themes) for more information. + @@ -135,6 +136,7 @@ This section contains the full reference for the `docs.json` file. You can specify a URL for any individual icon, regardless of the library setting. + @@ -232,12 +234,12 @@ This section contains the full reference for the `docs.json` file. Background color for light mode. - + Must be a hex code beginning with `#`. Background color for dark mode. - + Must be a hex code beginning with `#`. @@ -370,12 +372,12 @@ This section contains the full reference for the `docs.json` file. Anchor color for light mode. - + Must be a hex code beginning with `#`. Anchor color for dark mode. - + Must be a hex code beginning with `#`. @@ -391,7 +393,7 @@ This section contains the full reference for the `docs.json` file. Dropdown menus for organizing related content. - + Display name of the dropdown. @@ -522,7 +524,7 @@ This section contains the full reference for the `docs.json` file. - Contextual menu for AI-optimized content and integrations. + Contextual menu for AI-optimized content and integrations. @@ -538,6 +540,7 @@ This section contains the full reference for the `docs.json` file. The contextual menu is only available on preview and production deployments. + @@ -553,12 +556,12 @@ This section contains the full reference for the `docs.json` file. URL or path to your OpenAPI specification file. - + Minimum length: 1 Directory to search for OpenAPI files. - + Do not include a leading slash. @@ -574,7 +577,7 @@ This section contains the full reference for the `docs.json` file. Directory to search for AsyncAPI files. - + Do not include a leading slash. @@ -679,7 +682,7 @@ This section contains the full reference for the `docs.json` file. Clearbit data enrichment integration. - + Your Clearbit API key. @@ -688,7 +691,7 @@ This section contains the full reference for the `docs.json` file. Fathom analytics integration. - + Your Fathom site ID. @@ -697,7 +700,7 @@ This section contains the full reference for the `docs.json` file. Front chat integration. - + Your Front chat snippet ID. @@ -708,29 +711,29 @@ This section contains the full reference for the `docs.json` file. Google Analytics 4 integration. - + Your Google Analytics 4 measurement ID. - + Must match pattern: ^G Google Tag Manager integration. - + Your Google Tag Manager tag ID. - + Must match pattern: ^G Heap analytics integration. - + Your Heap app ID. @@ -739,7 +742,7 @@ This section contains the full reference for the `docs.json` file. Hotjar integration. - + Your Hotjar ID. @@ -751,29 +754,29 @@ This section contains the full reference for the `docs.json` file. Intercom integration. - + Your Intercom app ID. - + Minimum length: 6 Koala integration. - + Your Koala public API key. - + Minimum length: 2 LogRocket integration. - + Your LogRocket app ID. @@ -791,7 +794,7 @@ This section contains the full reference for the `docs.json` file. Osano integration. - + Your Osano script source. @@ -800,7 +803,7 @@ This section contains the full reference for the `docs.json` file. Pirsch analytics integration. - + Your Pirsch ID. @@ -809,11 +812,11 @@ This section contains the full reference for the `docs.json` file. PostHog integration. - + Your PostHog API key. - + Must match pattern: ^phc\_ @@ -823,7 +826,7 @@ This section contains the full reference for the `docs.json` file. Plausible analytics integration. - + Your Plausible domain. @@ -835,7 +838,7 @@ This section contains the full reference for the `docs.json` file. Segment integration. - + Your Segment key. @@ -844,7 +847,7 @@ This section contains the full reference for the `docs.json` file. Telemetry settings. - + Whether to enable telemetry. @@ -853,7 +856,7 @@ This section contains the full reference for the `docs.json` file. Cookie settings. - + Key for cookies. @@ -863,6 +866,7 @@ This section contains the full reference for the `docs.json` file. + @@ -870,14 +874,13 @@ This section contains the full reference for the `docs.json` file. Error handling settings. - 404 "Page not found" error handling. - - 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. @@ -1209,7 +1212,7 @@ This section contains the full reference for the `docs.json` file. ``` - ```json title="docs.json" wrap lines highlight={13-31} + ```json title="docs.json" wrap lines { "$schema": "https://mintlify.com/docs.json", "theme": "maple", @@ -1222,66 +1225,87 @@ This section contains the full reference for the `docs.json` file. }, "navigation": { "global": { - "languages": [ - { - "language": "en", - "default": true, - "href": "/en" - }, + "anchors": [ { - "language": "es", - "href": "/es" + "anchor": "Documentation", + "href": "https://mintlify.com/docs" }, { - "language": "pt-BR", - "href": "/pt-BR" - }, - { - "language": "ko", - "href": "/ko" - } - ], - "dropdowns": [ - { - "dropdown": "Documentation", - "icon": "book", - "description": "How to use the Example Co. product", - "groups": [ - { - "group": "Getting started", - "pages": [ - "index", - "quickstart" - ] - }, - { - "group": "Customization", - "pages": [ - "settings", - "users", - "features" - ] - }, - { - "group": "Billing", - "pages": [ - "billing/overview", - "billing/payments", - "billing/subscriptions" - ] - } - ] - }, - { - "dropdown": "Changelog", - "icon": "history", - "description": "Updates and changes", - "pages": [ - "changelog" - ] + "anchor": "Changelog", + "href": "https://mintlify.com/docs/changelog" } ] - } + }, + "languages": [ // [!code highlight:3] + { + "language": "en", + "dropdowns": [ + { + "dropdown": "Documentation", + "icon": "book", + "description": "How to use the Example Co. product", + "pages": [ + { + "group": "Getting started", + "pages": ["index", "quickstart"] + }, + { + "group": "Customization", + "pages": ["settings", "users", "features"] + }, + { + "group": "Billing", + "pages": [ + "billing/overview", + "billing/payments", + "billing/subscriptions" + ] + } + ] + }, + { + "dropdown": "Changelog", + "icon": "history", + "description": "Updates and changes", + "pages": ["changelog"] + } + ] + }, + { + "language": "es",// [!code highlight] + "dropdowns": [ + { + "dropdown": "Documentación", + "icon": "book", + "description": "Cómo usar el producto de Example Co.", + "pages": [ + { + "group": "Comenzando", + "pages": ["es/index", "es/quickstart"] + }, + { + "group": "Personalización", + "pages": ["es/settings", "es/users", "es/features"] + }, + { + "group": "Billing", + "pages": [ + "es/billing/overview", + "es/billing/payments", + "es/billing/subscriptions" + ] + } + ] + }, + { + "dropdown": "Changelog", + "icon": "history", + "description": "Actualizaciones y cambios", + "pages": ["es/changelog"] + } + ] + } + ] }, "logo": { "light": "/logo-light.svg", @@ -1361,12 +1385,7 @@ This section contains the full reference for the `docs.json` file. } }, "contextual": { - "options": [ - "copy", - "view", - "chatgpt", - "claude" - ] + "options": ["copy", "view", "chatgpt", "claude"] }, "errors": { "404": {