Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 37 additions & 12 deletions customize/themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,36 +28,61 @@
</div>
</div>
</a>
);

Check warning on line 31 in customize/themes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/themes.mdx#L31

Use semicolons judiciously.
};

Check warning on line 32 in customize/themes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/themes.mdx#L32

Use semicolons judiciously.

<div className="pt-10 pb-24 px-4 max-w-3xl mx-auto prose prose-gray">
<label className="eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold">Core Concepts</label>
<h1 className="mt-1 mb-2 text-2xl sm:text-3xl text-gray-900 tracking-tight dark:text-gray-200 font-semibold">Themes</h1>
<label className="text-lg prose prose-gray dark:prose-invert">Customize the appearance of your documentation<br /><br />Configure [theme](/organize/settings-appearance#theme) in docs.json using one of the following themes.</label>

Check warning on line 37 in customize/themes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/themes.mdx#L37

Use 'JSON' instead of 'json'.

<br />
<br />

<div className="mt-10 grid grid-cols-1 sm:grid-cols-2 gap-8 not-prose">
<div className="mt-10 grid grid-cols-1 sm:grid-cols-2 gap-8 not-prose">
<ThemeCard title="Mint" value="mint" description="Classic documentation theme with time-tested layouts and familiar navigation." href="https://mint.mintlify.app" />

<ThemeCard title="Mint" value="mint" description="Classic documentation theme with time-tested layouts and familiar navigation." href="https://mint.mintlify.site" />
<ThemeCard title="Maple" value="maple" description="Modern, clean aesthetics perfect for AI and SaaS products." href="https://maple.mintlify.app" />

<ThemeCard title="Maple" value="maple" description="Modern, clean aesthetics perfect for AI and SaaS products." href="https://maple.mintlify.site" />
<ThemeCard title="Palm" value="palm" description="Sophisticated fintech theme with deep customization for enterprise documentation." href="https://palm.mintlify.app" />

<ThemeCard title="Palm" value="palm" description="Sophisticated fintech theme with deep customization for enterprise documentation." href="https://palm.mintlify.site" />
<ThemeCard title="Willow" value="willow" description="Stripped-back essentials for distraction-free documentation." href="https://willow.mintlify.app" />

<ThemeCard title="Willow" value="willow" description="Stripped-back essentials for distraction-free documentation." href="https://willow.mintlify.site" />
<ThemeCard title="Linden" value="linden" description="Retro terminal vibes with monospace fonts for that 80s hacker aesthetic." href="https://linden.mintlify.app" />

<ThemeCard title="Linden" value="linden" description="Retro terminal vibes with monospace fonts for that 80s hacker aesthetic." href="https://linden.mintlify.site" />
<ThemeCard title="Almond" value="almond" description="Card-based organization meets minimalist design for intuitive navigation." href="https://almond.mintlify.app" />

<ThemeCard title="Almond" value="almond" description="Card-based organization meets minimalist design for intuitive navigation." href="https://almond.mintlify.site" />
<ThemeCard title="Aspen" value="aspen" description="Modern documentation crafted for complex navigation and custom components." href="https://aspen.mintlify.app" />

<ThemeCard title="Aspen" value="aspen" description="Modern documentation crafted for complex navigation and custom components." href="https://aspen.mintlify.site" />
<ThemeCard title="Sequoia" value="sequoia" description="Minimal, elegant layouts designed for large-scale content-focused documentation." href="https://sequoia.mintlify.app" />

<ThemeCard title="Sequoia" value="sequoia" description="Minimal, elegant layouts designed for large-scale content-focused documentation." href="https://sequoia.mintlify.site" />
<ThemeCard title="Luma" value="luma" description="Clean, minimal design for polished documentation." href="https://luma.mintlify.app" />
</div>
</div>

<ThemeCard title="Luma" value="luma" description="Clean, minimal design for polished documentation." href="https://luma.mintlify.site" />
<div className="pt-10 pb-24 px-4 max-w-3xl mx-auto prose prose-gray">
<label className="eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold">Core Concepts</label>
<h1 className="mt-1 mb-2 text-2xl sm:text-3xl text-gray-900 tracking-tight dark:text-gray-200 font-semibold">Themes</h1>
<label className="text-lg prose prose-gray dark:prose-invert">Customize the appearance of your documentation<br /><br />Configure [theme](/organize/settings-appearance#theme) in docs.json using one of the following themes.</label>

Check warning on line 65 in customize/themes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/themes.mdx#L65

Use 'JSON' instead of 'json'.

</div>
<br />

<div className="mt-10 grid grid-cols-1 sm:grid-cols-2 gap-8 not-prose">
<ThemeCard title="Mint" value="mint" description="Classic documentation theme with time-tested layouts and familiar navigation." href="https://mint.mintlify.site" />

<ThemeCard title="Maple" value="maple" description="Modern, clean aesthetics perfect for AI and SaaS products." href="https://maple.mintlify.site" />

<ThemeCard title="Palm" value="palm" description="Sophisticated fintech theme with deep customization for enterprise documentation." href="https://palm.mintlify.site" />

<ThemeCard title="Willow" value="willow" description="Stripped-back essentials for distraction-free documentation." href="https://willow.mintlify.site" />

<ThemeCard title="Linden" value="linden" description="Retro terminal vibes with monospace fonts for that 80s hacker aesthetic." href="https://linden.mintlify.site" />

<ThemeCard title="Almond" value="almond" description="Card-based organization meets minimalist design for intuitive navigation." href="https://almond.mintlify.site" />

<ThemeCard title="Aspen" value="aspen" description="Modern documentation crafted for complex navigation and custom components." href="https://aspen.mintlify.site" />

<ThemeCard title="Sequoia" value="sequoia" description="Minimal, elegant layouts designed for large-scale content-focused documentation." href="https://sequoia.mintlify.site" />

<ThemeCard title="Luma" value="luma" description="Clean, minimal design for polished documentation." href="https://luma.mintlify.site" />
</div>
</div>
Binary file added images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 45 additions & 2 deletions organize/settings-structure.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
title: "Site structure"
description: "Configure navbar, navigation groups, footer links, banner, contextual menu, redirects, and other structural elements in your docs.json file."

Check warning on line 3 in organize/settings-structure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["navbar", "navigation", "footer", "banner", "contextual", "redirects", "variables", "metadata", "docs.json"]
---

import IconsOptional from "/snippets/icons-optional.mdx";

# header

Check warning on line 9 in organize/settings-structure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L9

'header' should use sentence-style capitalization.

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
Expand All @@ -29,10 +33,13 @@
<ResponseField name="tab" type="string" required>
Display name of the tab. Minimum length: 1.
</ResponseField>

<IconsOptional />

<ResponseField name="hidden" type="boolean">
Whether to hide this tab by default.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
URL or path for the tab destination.
</ResponseField>
Expand All @@ -46,22 +53,27 @@
<ResponseField name="anchor" type="string" required>
Display name of the anchor. Minimum length: 1.
</ResponseField>

<IconsOptional />

<ResponseField name="color" type="object">
Custom colors for the anchor icon.

<Expandable title="color">
<ResponseField name="light" type="string">
Anchor color for light mode. Must be a hex code beginning with `#`.
</ResponseField>

<ResponseField name="dark" type="string">
Anchor color for dark mode. Must be a hex code beginning with `#`.
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="hidden" type="boolean">
Whether to hide this anchor by default.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
URL or path for the anchor destination.
</ResponseField>
Expand All @@ -75,10 +87,13 @@
<ResponseField name="dropdown" type="string" required>
Display name of the dropdown. Minimum length: 1.
</ResponseField>

<IconsOptional />

<ResponseField name="hidden" type="boolean">
Whether to hide this dropdown by default.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
URL or path for the dropdown destination.
</ResponseField>
Expand All @@ -90,14 +105,17 @@

<Expandable title="languages">
<ResponseField name="language" type='"ar" | "ca" | "cn" | "cs" | "de" | "en" | "es" | "fi" | "fr" | "fr-CA" | "he" | "hi" | "hu" | "id" | "it" | "ja" | "jp" | "ko" | "lv" | "nl" | "no" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sv" | "tr" | "uk" | "uz" | "vi" | "zh" | "zh-Hans" | "zh-Hant"' required>
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.
</ResponseField>

<ResponseField name="default" type="boolean">
Whether this is the default language.
</ResponseField>

<ResponseField name="hidden" type="boolean">
Whether to hide this language option by default.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
A valid path or external link to this language version of your documentation.
</ResponseField>
Expand All @@ -111,12 +129,15 @@
<ResponseField name="version" type="string" required>
Display name of the version. Minimum length: 1.
</ResponseField>

<ResponseField name="default" type="boolean">
Whether this is the default version.
</ResponseField>

<ResponseField name="hidden" type="boolean">
Whether to hide this version by default.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
URL or path to this version of your documentation.
</ResponseField>
Expand All @@ -130,9 +151,11 @@
<ResponseField name="product" type="string" required>
Display name of the product.
</ResponseField>

<ResponseField name="description" type="string">
Description of the product.
</ResponseField>

<IconsOptional />
</Expandable>
</ResponseField>
Expand All @@ -146,18 +169,23 @@
<ResponseField name="language" type='"ar" | "ca" | "cn" | "cs" | "de" | "en" | "es" | "fi" | "fr" | "fr-CA" | "he" | "hi" | "hu" | "id" | "it" | "ja" | "jp" | "ko" | "lv" | "nl" | "no" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sv" | "tr" | "uk" | "uz" | "vi" | "zh" | "zh-Hans" | "zh-Hant"' required>
Language code in ISO 639-1 format.
</ResponseField>

<ResponseField name="default" type="boolean">
Whether this is the default language.
</ResponseField>

<ResponseField name="banner" type="object">
Language-specific banner configuration. Accepts the same options as the top-level [`banner`](#banner) field.
</ResponseField>

<ResponseField name="footer" type="object">
Language-specific footer configuration. Accepts the same options as the top-level [`footer`](#footer) field.
</ResponseField>

<ResponseField name="navbar" type="object">
Language-specific navbar configuration. Accepts the same options as the top-level [`navbar`](#navbar) field.
</ResponseField>

<ResponseField name="hidden" type="boolean">
Whether to hide this language option by default.
</ResponseField>
Expand All @@ -171,6 +199,7 @@
<ResponseField name="default" type="boolean">
Set to `true` to make this the default version. If omitted, the first version in the array is the default.
</ResponseField>

<ResponseField name="tag" type="string">
Badge label displayed next to the version in the selector. Use to highlight versions such as `"Latest"`, `"Recommended"`, or `"Beta"`.
</ResponseField>
Expand All @@ -182,7 +211,7 @@
</ResponseField>

<ResponseField name="navigation.anchors" type="array of object">
Sidebar [anchors](/organize/navigation#anchors).

Check warning on line 214 in organize/settings-structure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-structure.mdx#L214

Use 'sidebars?' instead of 'Sidebar'.
</ResponseField>

<ResponseField name="navigation.dropdowns" type="array of object">
Expand Down Expand Up @@ -220,12 +249,15 @@
<ResponseField name="type" type='"github" | "discord"'>
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.
</ResponseField>

<ResponseField name="label" type="string">
Link text. Required when `type` is not set. Optional for `github` and `discord`. If omitted, Mintlify generates the label from API data.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
Link destination. Must be a valid external URL. For `github`, must be a GitHub repository URL. For `discord`, must be a Discord invite URL.
</ResponseField>

<IconsOptional />
</Expandable>
</ResponseField>
Expand All @@ -237,9 +269,11 @@
<ResponseField name="type" type='"button" | "github" | "discord"' required>
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.
</ResponseField>

<ResponseField name="label" type="string">
Button text. Required when `type` is `button`. Optional for `github` and `discord`.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
Button destination. Must be an external URL. For `github`, must be a GitHub repository URL. For `discord`, must be a Discord invite URL.
</ResponseField>
Expand Down Expand Up @@ -288,13 +322,15 @@
<ResponseField name="header" type="string">
Column header title. Minimum length: 1.
</ResponseField>

<ResponseField name="items" type="array of object" required>
Links to display in the column.

<Expandable title="items">
<ResponseField name="label" type="string" required>
Link text. Minimum length: 1.
</ResponseField>

<ResponseField name="href" type="string (uri)" required>
Link destination URL.
</ResponseField>
Expand Down Expand Up @@ -376,6 +412,7 @@
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
Expand All @@ -400,16 +437,20 @@
<ResponseField name="title" type="string" required>
Display title for the custom option.
</ResponseField>

<ResponseField name="description" type="string" required>
Description text for the custom option.
</ResponseField>

<ResponseField name="icon" type="string">
Icon for the custom option. Supports icon library names, URLs, paths, or SVG code.
</ResponseField>

<ResponseField name="href" type="string or object" required>
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
Expand Down Expand Up @@ -477,9 +518,11 @@
<ResponseField name="redirect" type="boolean">
Whether to automatically redirect to the home page when a page is not found. Defaults to `true`.
</ResponseField>

<ResponseField name="title" type="string">
Custom title for the 404 page.
</ResponseField>

<ResponseField name="description" type="string">
Custom description for the 404 page. Supports MDX formatting including links, bold, and italic text, and custom components.
</ResponseField>
Expand Down Expand Up @@ -543,4 +586,4 @@
"metadata": {
"timestamp": true
}
```
```
21 changes: 19 additions & 2 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Global settings"
description: "Configure your Mintlify documentation site with docs.json, the required configuration file that controls navigation, appearance, integrations, and more."

Check warning on line 3 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["docs.json", "configuration", "setup", "mint.json"]
---

Expand All @@ -11,7 +11,7 @@
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 |
Expand Down Expand Up @@ -48,18 +48,23 @@
<Card title="Appearance and branding" icon="palette" href="/organize/settings-appearance">
Customize the visual appearance of your site including theme, colors, logo, favicon, fonts, and background.
</Card>

<Card title="Site structure" icon="layout-panel-left" href="/organize/settings-structure">
Design the information architecture and UX of your site including the navbar, footer, banner, navigation, and redirects.
</Card>

<Card title="API settings" icon="square-terminal" href="/organize/settings-api">
Control the display and behavior of API documentation including OpenAPI and AsyncAPI specs, API playground, and code examples.
</Card>

<Card title="Integrations" icon="plug" href="/organize/settings-integrations">
Connect your site to third-party services for analytics, chat, and more.
</Card>

<Card title="SEO & search" icon="search" href="/organize/settings-seo">
Control how search engines index your site including meta tags, search, and page timestamps.
</Card>

<Card title="Schema reference" icon="code" href="/organize/settings-reference">
Complete reference for all `docs.json` properties.
</Card>
Expand Down Expand Up @@ -118,6 +123,18 @@
}
```

## Related

<CardGroup cols={2}>
<Card title="Themes" icon="palette" href="/customize/themes">
Explore the available layout themes to customize the look and feel of your site.
</Card>

<Card title="Navigation" icon="map" href="/organize/navigation">
Learn how to structure your site's navigation, tabs, anchors, and sidebar.
</Card>
</CardGroup>

## Upgrade from `mint.json`

If your project uses the deprecated `mint.json` file, use the [CLI](/cli) to upgrade to `docs.json`.
Expand Down Expand Up @@ -160,4 +177,4 @@
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured correctly, you can safely delete your old `mint.json` file.
</Step>
</Steps>
</Steps>
Loading
Loading