diff --git a/customize/themes.mdx b/customize/themes.mdx index 36700fe30b..85963aea4c 100644 --- a/customize/themes.mdx +++ b/customize/themes.mdx @@ -36,28 +36,53 @@ export const ThemeCard = ({ title, value, description, href }) => {

Themes

-
+
-
+
+ - + - + - + - + - + - + - + - + +
+
- +
+ +

Themes

+ -
+
+ +
+ + + + + + + + + + + + + + + + +
\ No newline at end of file diff --git a/images/CleanShot-2026-06-10-at-14.52.04@2x.png b/images/CleanShot-2026-06-10-at-14.52.04@2x.png new file mode 100644 index 0000000000..0bc51b30e6 Binary files /dev/null and b/images/CleanShot-2026-06-10-at-14.52.04@2x.png differ diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx index 25c62c5be6..4bd78d1e94 100644 --- a/organize/settings-structure.mdx +++ b/organize/settings-structure.mdx @@ -6,6 +6,10 @@ keywords: ["navbar", "navigation", "footer", "banner", "contextual", "redirects" import IconsOptional from "/snippets/icons-optional.mdx"; +# header + +body text + Use these settings in your `docs.json` file to control your site's information architecture and user experience. Modify the navbar, footer, banners, navigation behavior, contextual menus, redirects, and global content variables. ## Settings @@ -29,10 +33,13 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Display name of the tab. Minimum length: 1. + + Whether to hide this tab by default. + URL or path for the tab destination. @@ -46,7 +53,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Display name of the anchor. Minimum length: 1. + + Custom colors for the anchor icon. @@ -54,14 +63,17 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Anchor color for light mode. Must be a hex code beginning with `#`. + Anchor color for dark mode. Must be a hex code beginning with `#`. + Whether to hide this anchor by default. + URL or path for the anchor destination. @@ -75,10 +87,13 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Display name of the dropdown. Minimum length: 1. + + Whether to hide this dropdown by default. + URL or path for the dropdown destination. @@ -90,14 +105,17 @@ See [Navigation](/organize/navigation) for complete documentation on building yo - Language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. + Language code in [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. + Whether this is the default language. + Whether to hide this language option by default. + A valid path or external link to this language version of your documentation. @@ -111,12 +129,15 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Display name of the version. Minimum length: 1. + Whether this is the default version. + Whether to hide this version by default. + URL or path to this version of your documentation. @@ -130,9 +151,11 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Display name of the product. + Description of the product. + @@ -146,18 +169,23 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Language code in ISO 639-1 format. + Whether this is the default language. + Language-specific banner configuration. Accepts the same options as the top-level [`banner`](#banner) field. + Language-specific footer configuration. Accepts the same options as the top-level [`footer`](#footer) field. + Language-specific navbar configuration. Accepts the same options as the top-level [`navbar`](#navbar) field. + Whether to hide this language option by default. @@ -171,6 +199,7 @@ See [Navigation](/organize/navigation) for complete documentation on building yo Set to `true` to make this the default version. If omitted, the first version in the array is the default. + Badge label displayed next to the version in the selector. Use to highlight versions such as `"Latest"`, `"Recommended"`, or `"Beta"`. @@ -220,12 +249,15 @@ Links and buttons displayed in the top navigation bar. Optional link type. Omit for a standard text link. Set to `github` to link to a GitHub repository and show its star count. Set to `discord` to link to a Discord server and show its online user count. + Link text. Required when `type` is not set. Optional for `github` and `discord`. If omitted, Mintlify generates the label from API data. + Link destination. Must be a valid external URL. For `github`, must be a GitHub repository URL. For `discord`, must be a Discord invite URL. + @@ -237,9 +269,11 @@ Links and buttons displayed in the top navigation bar. Button style. Choose `button` for a standard button, `github` for a GitHub repository link with star count, or `discord` for a Discord invite with online user count. + Button text. Required when `type` is `button`. Optional for `github` and `discord`. + Button destination. Must be an external URL. For `github`, must be a GitHub repository URL. For `discord`, must be a Discord invite URL. @@ -288,6 +322,7 @@ Footer content and social media links. Column header title. Minimum length: 1. + Links to display in the column. @@ -295,6 +330,7 @@ Footer content and social media links. Link text. Minimum length: 1. + Link destination URL. @@ -376,6 +412,7 @@ The contextual menu gives users quick access to AI tools and page actions. It ap Actions available in the contextual menu. The first option in the array appears as the default action. Built-in options: + - `"add-mcp"`—Add your MCP server to the user's configuration - `"aistudio"`—Send the current page to Google AI Studio - `"assistant"`—Open the AI assistant with the current page as context @@ -400,16 +437,20 @@ The contextual menu gives users quick access to AI tools and page actions. It ap 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. Can be a URL string or an object with `base` and optional `query` parameters. Available placeholder values: + - `$page`—Current page content - `$path`—Current page path - `$mcp`—MCP server URL @@ -477,9 +518,11 @@ Custom error page settings. Whether to automatically redirect to the home page when a page is not found. Defaults to `true`. + Custom title for the 404 page. + Custom description for the 404 page. Supports MDX formatting including links, bold, and italic text, and custom components. @@ -543,4 +586,4 @@ Page-level metadata settings applied globally. "metadata": { "timestamp": true } -``` +``` \ No newline at end of file diff --git a/organize/settings.mdx b/organize/settings.mdx index 9e809a345c..9100fca103 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -11,7 +11,7 @@ The `docs.json` file is the central configuration file for your Mintlify documen You must define four fields to build a working site. | Field | Description | -|---|---| +| --- | --- | | `name` | Your project or organization name | | `theme` | The layout [theme](/customize/themes) for your site | | `colors.primary` | Primary brand color as a hex code | @@ -48,18 +48,23 @@ For the best editing experience, include the `$schema` reference at the top of y Customize the visual appearance of your site including theme, colors, logo, favicon, fonts, and background. + Design the information architecture and UX of your site including the navbar, footer, banner, navigation, and redirects. + Control the display and behavior of API documentation including OpenAPI and AsyncAPI specs, API playground, and code examples. + Connect your site to third-party services for analytics, chat, and more. + Control how search engines index your site including meta tags, search, and page timestamps. + Complete reference for all `docs.json` properties. @@ -118,6 +123,18 @@ If a `$ref` resolves to an object, Mintlify merges any sibling keys in the same } ``` +## Related + + + + Explore the available layout themes to customize the look and feel of your site. + + + + Learn how to structure your site's navigation, tabs, anchors, and sidebar. + + + ## Upgrade from `mint.json` If your project uses the deprecated `mint.json` file, use the [CLI](/cli) to upgrade to `docs.json`. @@ -160,4 +177,4 @@ If your project uses the deprecated `mint.json` file, use the [CLI](/cli) to upg After verifying your `docs.json` is configured correctly, you can safely delete your old `mint.json` file. - + \ No newline at end of file diff --git a/quickstart.mdx b/quickstart.mdx index 4fc7601ca7..8b57a80b39 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -9,6 +9,9 @@ import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; After you complete this guide, you'll have a live documentation site ready to customize and update. + + + ## Before you begin Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. @@ -27,7 +30,7 @@ When you connect your documentation repository to your project, you can work on Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments. -After onboarding, your documentation site deploys and is accessible at your `.mintlify.site` URL. +After onboarding, your documentation site deploys and is accessible at your `.mintlify.appapp` URL. After onboarding, your documentation site deploys and is accessible at your `.mintlify.site` URL. @@ -39,7 +42,7 @@ After onboarding, your documentation site deploys and is accessible at your `.mi ## View your deployed site -Your documentation site is now deployed at `https://.mintlify.site`. +Your documentation site is now deployed at `https://.mintlify.appapp`. Your documentation site is now deployed at `https://.mintlify.site`. Find your exact URL on the **Overview** page of your [dashboard](https://app.mintlify.com/).