Skip to content
Merged
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
60 changes: 50 additions & 10 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
</ResponseField>

<ResponseField name="colors" type="object" required>
The colors used in your documentation. Colors are applied differently across themes. If you only provide a primary color, it will be used for all color elements.

Check warning on line 53 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L53

Avoid using 'will'.

<Expandable title="Colors">
<ResponseField name="primary" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$" required>
Expand Down Expand Up @@ -115,7 +115,7 @@
Background image for your thumbnails. Can be a relative path or absolute URL.
</ResponseField>
<ResponseField name="fonts" type="object">
Font configuration for thumbnails. Only Google Fonts family names are supported.

Check warning on line 118 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L118

In general, use active voice instead of passive voice ('are supported').

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
Expand Down Expand Up @@ -304,7 +304,7 @@
Default theme mode. Choose `system` to match users' OS settings, or `light` or `dark` to force a specific mode. Defaults to `system`.
</ResponseField>
<ResponseField name="strict" type="boolean">
Whether to hide the light/dark mode toggle. Defaults to `true`.
Whether to hide the light/dark mode toggle. Defaults to `false`.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -550,7 +550,7 @@

<Expandable title="Interaction">
<ResponseField name="drilldown" type="boolean">
Control automatic navigation behavior when selecting navigation groups. Set to `true` to force navigation to the first page when a navigation group is expanded. Set to `false` to prevent navigation and only expand or collapse the group. Leave unset to use the theme's default behavior.

Check warning on line 553 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L553

In general, use active voice instead of passive voice ('is expanded').
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -560,7 +560,7 @@

<Expandable title="Metadata">
<ResponseField name="timestamp" type="boolean">
Enable the last modified date on all pages. When enabled, all pages will display the date the content was last modified. Defaults to `false`.

Check warning on line 563 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L563

Avoid using 'will'.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -612,8 +612,8 @@
Site-wide banner displayed at the top of pages.

<Expandable title="Banner">
<ResponseField name="content" type="string">
The content of the banner. Supports plain text and Markdown formatting. For example:
<ResponseField name="content" type="string" required>
The text content displayed in the banner. Supports basic MDX formatting including links, bold, and italic text. Custom components are not supported. For example:

Check warning on line 616 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L616

Use 'aren't' instead of 'are not'.

```json
{
Expand All @@ -622,7 +622,7 @@
```
</ResponseField>
<ResponseField name="dismissible" type="boolean">
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`.
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -638,7 +638,7 @@
Destination path to redirect to. Example: `/new-page`
</ResponseField>
<ResponseField name="permanent" type="boolean">
Whether to use a permanent redirect (301). Defaults to `true`.

Check warning on line 641 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L641

Use parentheses judiciously.
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -647,7 +647,7 @@
Contextual menu for AI-optimized content and integrations.

<Expandable title="Contextual">
<ResponseField name="options" type='array of "copy" | "view" | "chatgpt" | "claude" | "perplexity" | "mcp" | "cursor" | "vscode"' required>
<ResponseField name="options" type='array of "copy" | "view" | "chatgpt" | "claude" | "perplexity" | "mcp" | "cursor" | "vscode" | object' required>
Actions available in the contextual menu. The first option appears as the default.

- `copy`: Copy the current page as Markdown to the clipboard.
Expand All @@ -659,6 +659,28 @@
- `cursor`: Installs your hosted MCP server in Cursor.
- `vscode`: Installs your hosted MCP server in VSCode.

Define custom contextual menu options as objects with the following properties:

<Expandable title="Custom option">
<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 for the custom option. Can be a simple URL string or an object with `base` and optional `query` parameters.

Placeholder values:
- `$page`: Current page content
- `$path`: Current page path
- `$mcp`: MCP server URL
</ResponseField>
</Expandable>

<img
src="/images/page-context-menu.png"
alt="Contextual Menu"
Expand All @@ -672,7 +694,7 @@
</Expandable>
</ResponseField>

### API Configurations

Check warning on line 697 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L697

'API Configurations' should use sentence-style capitalization.

<ResponseField name="api" type="object">
API documentation and interactive playground settings.
Expand Down Expand Up @@ -782,10 +804,10 @@
</Expandable>
</ResponseField>

### SEO and search

Check warning on line 807 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L807

Spell out 'SEO', if it's unfamiliar to the audience.

Check warning on line 807 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L807

'SEO and search' should use sentence-style capitalization.

<ResponseField name="seo" type="object">
SEO indexing configurations.

Check warning on line 810 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L810

Spell out 'SEO', if it's unfamiliar to the audience.

<Expandable title="Seo">
<ResponseField name="metatags" type="object">
Expand Down Expand Up @@ -822,6 +844,15 @@
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="clarity" type="object">
Microsoft Clarity integration.

<Expandable title="Clarity">
<ResponseField name="projectId" type="string" required>
Your Microsoft Clarity project ID.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="clearbit" type="object">
Clearbit data enrichment integration.

Expand Down Expand Up @@ -882,6 +913,18 @@
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="hightouch" type="object">
Hightouch integration.

<Expandable title="Hightouch">
<ResponseField name="writeKey" type="string" required>
Your Hightouch write key.
</ResponseField>
<ResponseField name="apiHost" type="string">
Your Hightouch API host.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="hotjar" type="object">
Hotjar integration.

Expand Down Expand Up @@ -953,9 +996,6 @@
<ResponseField name="apiHost" type="string (uri)">
Your PostHog API host.
</ResponseField>
<ResponseField name="sessionRecording" type="boolean" default="true">
Enable or disable session recording.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="plausible" type="object">
Expand Down Expand Up @@ -1018,13 +1058,13 @@

<Expandable title="404">
<ResponseField name="redirect" type="boolean">
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`.
</ResponseField>
<ResponseField name="title" type="string">
Custom title for the 404 error page.
</ResponseField>
<ResponseField name="description" type="string">
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.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down