diff --git a/docs.json b/docs.json index 3142b96b4..76faaeb9f 100644 --- a/docs.json +++ b/docs.json @@ -71,7 +71,6 @@ "api-playground/asyncapi/setup", "api-playground/asyncapi/playground" ] - }, { "group": "MDX", @@ -390,5 +389,5 @@ "og:title": "Mintlify Docs", "og:description": "Mintlify is a documentation platform that helps you create, manage, and share documentation for your projects." } -} + } } diff --git a/navigation/divisions.mdx b/navigation/divisions.mdx index c965ffee8..13da2f802 100644 --- a/navigation/divisions.mdx +++ b/navigation/divisions.mdx @@ -198,4 +198,49 @@ You can use any combination of anchors, tabs, and dropdowns - either one can be } ``` + +```json Tabs with external anchors +{ + "navigation": { + "tabs": [ + { + "tab": "Tab 1", + "global": { + "anchors": [ + { + "anchor": "Anchor 1", + "href": "https://mintlify.com/docs" + } + ] + }, + "groups": [ + { + "group": "Group 1", + "pages": [ + "some-folder/file-1", + "another-folder/file-2" + "just-a-file" + ] + } + ] + } + { + "tab": "Tab 2", + "groups": [ + { + "group": "Group 2", + "pages": [ + "some-other-folder/file-1", + "various-different-folders/file-2", + "another-file" + ] + } + ] + } + ] + } +} +``` + + diff --git a/settings/global.mdx b/settings/global.mdx index 3b71f7448..9d8bd473b 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -14,9 +14,8 @@ Every documentation site requires a `docs.json` file that contains the core conf ### Customization - - The layout theme of the project. Examples: - [Maple](https://maple.mintlify.app/), [Palm](https://palm.mintlify.app/), + + The layout theme of the project. Check out the [Themes](/themes) page for more information. @@ -105,7 +104,7 @@ Every documentation site requires a `docs.json` file that contains the core conf Icon library settings - + The icon library to be used. Defaults to `fontawesome`. @@ -169,7 +168,7 @@ Every documentation site requires a `docs.json` file that contains the core conf - The default light/dark mode. Defaults to system + The default light/dark mode. Defaults to `system` Whether to hide the light / dark mode toggle. Defaults to `true`. @@ -236,9 +235,10 @@ Every documentation site requires a `docs.json` file that contains the core conf + The label for the primary button. This only applies when `type` is set to `button`. - A valid path or external link + A valid path or external link. If `type` is set to `github`, this will be the URL to the repository. @@ -257,7 +257,7 @@ Every documentation site requires a `docs.json` file that contains the core conf - + The name of the language in the ISO 639-1 format @@ -343,30 +343,54 @@ Every documentation site requires a `docs.json` file that contains the core conf + + + + + The name of the dropdown + + Minimum length: 1 + + + The icon to be displayed in the section + + + Whether the current option is default hidden + + + An external link + + + - Organizing by languages + Organizing by [languages](/navigation/localization) - Organizing by versions + Organizing by [versions](/navigation/versions) - Organizing by tabs + Organizing by [tabs](/navigation/divisions#tabs) - Organizing by anchors + Organizing by [anchors](/navigation/divisions#anchors) + + + + + Organizing by [dropdowns](/navigation/divisions#dropdowns) - Organizing by groups + Organizing by [groups](/navigation/pages#pages) - An array of page paths or groups + An array of [page paths or groups](/navigation/pages#groups) @@ -385,7 +409,7 @@ Every documentation site requires a `docs.json` file that contains the core conf } ``` - Valid property names: bluesky, discord, facebook, github, hacker-news, instagram, linkedin, medium, podcast, reddit, slack, telegram, threads, twitter, website, x, youtube + Valid property names: `x`, `website`, `facebook`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter`, `x-twitter`, `earth-americas`, `bluesky`, `threads`, `reddit`, `podcast` The links to be displayed in the footer @@ -448,7 +472,7 @@ Every documentation site requires a `docs.json` file that contains the core conf - + The options to be displayed in the contextual menu. The first option is the default option. - `copy`: Copy the current page as markdown to the clipboard - `view`: View the current page as markdown in a new tab @@ -474,6 +498,19 @@ Every documentation site requires a `docs.json` file that contains the core conf A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s) + + + Minimum length: 1 + + + no starting slash in the directory + + + + + A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s) + + Minimum length: 1 @@ -689,13 +726,26 @@ Every documentation site requires a `docs.json` file that contains the core conf - + + + + + + + + + + + + + +