Skip to content
Merged
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
1 change: 1 addition & 0 deletions ai/llmstxt.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "llms.txt"
description: "Automatically generate llms.txt and llms-full.txt files so AI tools like ChatGPT and Claude can index and understand your documentation."

Check warning on line 3 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L3

Use 'LLMs?' instead of 'llms'.
keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"]
boost: 3
---

import { PreviewButton } from "/snippets/previewbutton.jsx"
Expand All @@ -11,21 +12,21 @@
Mintlify automatically hosts an `llms.txt` file at the root of your project that lists all available pages in your documentation. This file is always up to date and requires zero maintenance. You can optionally add a custom `llms.txt` file to the root of your project.

<Note>
If your site requires authentication, `llms.txt` and `llms-full.txt` also require authentication to view. LLMs and AI tools that cannot authenticate into your site cannot access these files. The files exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).

Check warning on line 15 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L15

Use 'LLMs?' instead of 'llms'.

For more information on how authentication affects AI features, see [Feature availability](/deploy/authentication-setup#feature-availability).
</Note>

View your `llms.txt` by appending `/llms.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms.txt` for compatibility with tools that follow the `.well-known` convention.

<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site.</PreviewButton>

Check warning on line 22 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L22

Use 'LLMs?' instead of 'llms'.

Mintlify adds HTTP headers to every page response so AI tools can discover your `llms.txt` files without prior knowledge of their location:

- `Link: </llms.txt>; rel="llms-txt", </llms-full.txt>; rel="llms-full-txt"`: Follows the standard HTTP `Link` header format for resource discovery.

Check warning on line 26 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L26

Use 'LLMs?' instead of 'llms'.
- `X-Llms-Txt: /llms.txt`: A convenience header for tools that check for `llms.txt` support.

## llms.txt structure

Check warning on line 29 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L29

Use 'LLMs?' instead of 'llms'.

Check warning on line 29 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L29

'llms.txt structure' should use sentence-style capitalization.

An `llms.txt` file is a plain Markdown file that contains:

Expand Down Expand Up @@ -66,7 +67,7 @@

Mintlify automatically hosts an `llms-full.txt` file at the root of your project. View your `llms-full.txt` by appending `/llms-full.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms-full.txt` for compatibility with tools that follow the `.well-known` convention.

<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open the llms-full.txt for this site.</PreviewButton>

Check warning on line 70 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L70

Use 'LLMs?' instead of 'llms'.

## Custom files

Expand Down
1 change: 1 addition & 0 deletions ai/skillmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "skill.md"
description: "Make your documentation agent-ready with automatically generated skill.md files that describe your product's capabilities for AI agents."
keywords: ["AI agents", "skills", "agent skills", "agents"]
boost: 3
---

Mintlify hosts a `skill.md` file at the root of your project that describes what AI agents can do with your product.
Expand Down Expand Up @@ -45,7 +46,7 @@
Teach your users how to use `skill.md` files with agents so that they have better results using your product with their AI tools.
</Tip>

## `skill.md` structure

Check warning on line 49 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L49

'structure' should use sentence-style capitalization.

Mintlify generates a `skill.md` file following the [agentskills.io specification](https://agentskills.io/specification). The generated file includes:

Expand Down Expand Up @@ -104,7 +105,7 @@
docs.json
```

Mintlify resolves symlinks during deployment, so the skill files are discovered and served as if they were directly inside `.mintlify/skills/`. This works with both directory symlinks and individual skill symlinks.

Check warning on line 108 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L108

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

### Frontmatter fields

Expand Down
1 change: 1 addition & 0 deletions api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Playground"
description: "Let developers test API endpoints directly in your documentation with an interactive playground that sends real requests and shows responses."
keywords: ["interactive", "API", "endpoint testing", "live API requests", "request builder"]
boost: 3
---

The API playground is an interactive environment that lets users test and explore your API endpoints. Developers can craft API requests, submit them, and view responses without leaving your documentation.
Expand Down
1 change: 1 addition & 0 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Troubleshooting"
description: "Troubleshoot common issues with API playground configuration, including OpenAPI validation errors, missing endpoints, and auth problems."
keywords: ["API troubleshooting", "invalid OpenAPI", "configuration issues"]
boost: 3
---

If your API pages aren't displaying correctly, check these common configuration issues.
Expand Down
1 change: 1 addition & 0 deletions api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
title: "Introduction"
description: "Use the Mintlify REST API to trigger deployments, embed an AI assistant, export analytics data, and manage documentation programmatically."
keywords: ["REST API", "endpoints", "API keys"]
boost: 3
---

The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.

## Endpoints

Check warning on line 10 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L10

Use 'endpoints?' instead of 'Endpoints'.

- [Trigger update](/api/update/trigger): Trigger an update of your site when desired.
- [Get update status](/api/update/status): Get the status of an update and other details about your docs.
Expand Down
1 change: 1 addition & 0 deletions assistant/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
title: "Assistant"
description: "Add an AI-powered chat assistant to your documentation site that answers user questions, cites sources, and generates code examples on demand."
keywords: ["chat", "RAG", "user support", "multimodal"]
boost: 3
---

<Info>
The assistant is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=assistant) and is enabled by default for those plans.

Check warning on line 9 in assistant/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/index.mdx#L9

In general, use active voice instead of passive voice ('is enabled').
</Info>

## About the assistant
Expand Down
1 change: 1 addition & 0 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Commands"
description: "Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint analytics, and more."

Check warning on line 3 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L3

Use 'Dev' instead of 'dev'.
keywords: ["CLI", "mint", "commands", "flags", "reference"]
boost: 3
---

## Global flags
Expand Down Expand Up @@ -141,7 +142,7 @@
| --- | --- |
| `--page` | Filter conversations that reference a specific page in sources. |

#### `mint analytics conversation view <conversation-id>`

Check warning on line 145 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L145

'````' should use sentence-style capitalization.

View a single conversation by ID. Use `mint analytics conversation list` to get IDs.

Expand All @@ -157,7 +158,7 @@
mint analytics conversation buckets list
```

#### `mint analytics conversation buckets view <bucket-id>`

Check warning on line 161 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L161

'````' should use sentence-style capitalization.

View conversations in a category bucket. Use `mint analytics conversation buckets list` to get IDs.

Expand All @@ -175,7 +176,7 @@
mint config <subcommand> <key> [value]
```

| Subcommand | Description |

Check warning on line 179 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L179

Use 'subcommands?' instead of 'Subcommand'.
| --- | --- |
| `set <key> <value>` | Set a configuration value. |
| `get <key>` | Display a configuration value. |
Expand Down Expand Up @@ -242,7 +243,7 @@
| `--local-schema` | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. |

<Note>
The standalone `mint openapi-check` command is deprecated. Use `mint validate` instead.

Check warning on line 246 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L246

In general, use active voice instead of passive voice ('is deprecated').
</Note>

---
Expand Down Expand Up @@ -378,7 +379,7 @@

## Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does **not** collect personally identifiable information, project content, or file paths.

Check warning on line 382 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L382

Did you really mean 'informat'?

By default, the CLI collects telemetry data. You can opt out at any time using the `--telemetry` flag:

Expand Down
1 change: 1 addition & 0 deletions components/accordions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Accordions"
description: "Use the accordion component to show and hide content sections, organize related information, and enable progressive disclosure in your docs."
keywords: ["accordions", "collapsible content", "expandable sections", "progressive disclosure"]
boost: 3
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 1 addition & 0 deletions components/badge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Badge"
description: "Use the badge component to highlight status indicators, version labels, or metadata inline with customizable colors and hover tooltips."
keywords: ["badge", "label", "tag", "status", "indicator"]
boost: 3
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 1 addition & 0 deletions components/banner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Banner"
description: "Add a dismissible banner at the top of your documentation site to display important announcements, release notes, or notifications."
keywords: ["banner", "announcements", "site-wide"]
boost: 3
---

Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and you can make them dismissible. By default, banners use the color defined by the `colors.dark` property in your `docs.json`. You can change the appearance with the `type` property or override the background entirely with `color`.
Expand Down
1 change: 1 addition & 0 deletions components/callouts.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Callouts"

Check warning on line 2 in components/callouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/callouts.mdx#L2

Use 'callouts?' instead of 'Callouts'.
description: "Add info, notes, tips, checks, warnings, danger, and custom callout components to highlight important information in your documentation."
keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"]
boost: 3
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 1 addition & 0 deletions components/cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Cards"
description: "Use the Mintlify Card component to display links, icons, images, and grouped content as visual containers, including horizontal layouts and CardGroup grids."
keywords: ["cards", "visual containers"]
boost: 3
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 1 addition & 0 deletions components/color.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Color"
description: "Display color swatches with hex values and click-to-copy capability using the color component for design system and branding documentation."
keywords: ["color", "palette", "colors", "design system", "hex", "rgb", "rgba", "hsl", "oklch"]
boost: 3
---

Use the Color component to showcase color palettes in your documentation. Display colors in a compact grid or organize them in a table with labeled rows.
Expand All @@ -22,7 +23,7 @@
<Color.Item name="blue-500" value="#3B82F6" />
<Color.Item name="blue-600" value="#2563EB" />
<Color.Item name="blue-700" value="#1D4ED8" />
<Color.Item name="blue-800" value="#1E40AF" />

Check warning on line 26 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L26

'r.I' should have one space.
</Color>
```

Expand All @@ -44,7 +45,7 @@

```mdx Table example
<Color variant="table">
<Color.Row title="Primary">

Check warning on line 48 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L48

'Color.Row' should use sentence-style capitalization.

Check warning on line 48 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L48

'r.R' should have one space.
<Color.Item name="primary-500" value="#3B82F6" />
<Color.Item name="primary-600" value="#2563EB" />
<Color.Item name="primary-700" value="#1D4ED8" />
Expand Down
1 change: 1 addition & 0 deletions components/columns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Columns'
description: "Arrange cards and other components in a responsive multi-column grid layout with the columns component, including customizable column counts."
keywords: ['card groups', 'grid layout', 'multi-column layout']
boost: 3
---

The `Columns` component lets you arrange content in a responsive grid layout. It's most often used to put cards in a grid, by specifying the number of grid columns. You can also use the `Column` sub-component to wrap arbitrary content. Columns are responsive and automatically adjust for smaller screens.
Expand Down
1 change: 1 addition & 0 deletions components/examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Examples"
description: "Display code examples in the right sidebar panel on desktop devices to show request and response samples alongside API documentation."
keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"]
boost: 3
---

The `<RequestExample>` and `<ResponseExample>` components display code blocks in the right sidebar to create a two-column layout that keeps examples visible while users scroll through your content. Use these components for API documentation, but they work on all pages.
Expand Down
1 change: 1 addition & 0 deletions components/expandables.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Expandables"

Check warning on line 2 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L2

Use 'expandables' instead of 'Expandables'.
description: "Use the expandable component to toggle nested object properties in API documentation, showing child fields for request and response objects."
keywords: ["expandables", "nested properties", "expandable fields", "toggle content"]
boost: 3
---

Use expandables to show and hide nested content within response fields. They are particularly useful for displaying complex object properties in API documentation.
Expand Down
1 change: 1 addition & 0 deletions components/fields.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Fields"
description: "Use ParamField and ResponseField components to document API request and response parameters with types, defaults, and validation rules."
keywords: ["ParamField", "ResponseField", "request parameters", "response documentation"]
boost: 3
---

Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.
Expand Down
1 change: 1 addition & 0 deletions components/frames.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Frames"
description: "Wrap images, videos, and other components with the frame component to add styled borders, captions, and visual emphasis to your content."
keywords: ["image frames", "visual emphasis", "captions", "border"]
boost: 3
---

Use frames to display images, diagrams, videos, or other visual content with consistent styling and optional captions. Frames center content and provide visual separation from surrounding text.
Expand All @@ -20,7 +21,7 @@

### Markdown in captions

Captions support markdown formatting, including links and bold text.

Check warning on line 24 in components/frames.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/frames.mdx#L24

Use 'Markdown' instead of 'markdown'.

<Frame caption="Learn more about [Yosemite National Park](https://www.nps.gov/yose/index.htm) and plan your visit.">
<img src="https://mintlify-assets.b-cdn.net/yosemite.jpg" alt="Photograph of Yosemite Valley." />
Expand All @@ -32,7 +33,7 @@

## Hints

Add text that precedes the frame using the optional `hint` prop. Hints appear above the frame.

Check warning on line 36 in components/frames.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/frames.mdx#L36

Use 'preceding' instead of 'above'.

<Frame hint="If you plan to visit Yosemite National Park, secure your permits before you go." caption="Yosemite National Park is visited by over 3.5 million people every year.">
<img src="https://mintlify-assets.b-cdn.net/yellowstone.jpeg" alt="Photograph of a lake surrounded by trees with mountains in the distance in Yellowstone National Park." />
Expand All @@ -53,7 +54,7 @@
## Properties

<ResponseField name="caption" type="string">
Text that appears as part of the frame, centered below the content. Supports markdown formatting including links and bold text.

Check warning on line 57 in components/frames.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/frames.mdx#L57

Use 'Markdown' instead of 'markdown'.
</ResponseField>

<ResponseField name="hint" type="string">
Expand Down
1 change: 1 addition & 0 deletions components/icons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Icons"
description: "Add icons from Font Awesome, Lucide, Tabler, or custom sources to your documentation pages using the icon component with size and color options."
keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"]
boost: 3
---

import IconsRequired from "/snippets/icons-required.mdx";
Expand All @@ -16,7 +17,7 @@

## Inline icons

Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.

Check warning on line 20 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L20

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

```markdown Inline icon example
Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
Expand Down
1 change: 1 addition & 0 deletions components/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
description: "Browse the full Mintlify component library for layout, emphasis, API documentation, and navigation elements available in your MDX pages."
keywords:
["MDX components", "documentation components", "UI components", "components"]
boost: 3
---

Mintlify provides built-in MDX components for your documentation pages. Use these components to structure content, draw attention to important information, document APIs, and guide navigation.
Expand Down Expand Up @@ -32,7 +33,7 @@
## Draw attention

<Card
title="Callouts"

Check warning on line 36 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L36

Use 'callouts?' instead of 'Callouts'.
icon="message-square-warning"
href="/components/callouts"
>
Expand Down Expand Up @@ -115,8 +116,8 @@

<Card
title="Mermaid diagrams"
icon="git-branch"

Check warning on line 119 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L119

Use 'Git' instead of 'git'.
href="/components/mermaid-diagrams"

Check warning on line 120 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L120

Use 'Mermaid' instead of 'mermaid'.
>
Create flowcharts, sequence diagrams, and more.
</Card>
Expand Down
1 change: 1 addition & 0 deletions components/mermaid-diagrams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Mermaid"
description: "Create flowcharts, sequence diagrams, and other visualizations in your documentation using Mermaid syntax with automatic rendering."
keywords: ["Mermaid", "flowcharts", "diagrams"]
boost: 3
---

[Mermaid](https://mermaid.js.org/) lets you build flowcharts, sequence diagrams, Gantt charts, and other diagrams using text and code.
Expand Down
1 change: 1 addition & 0 deletions components/panel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Panel"
description: "Customize the right side panel content on documentation pages to display supplementary information, examples, or navigation elements."
keywords: ["sidebar"]
boost: 3
---

You can use the `<Panel>` component to customize the right side panel of a page with any components that you want.
Expand Down
1 change: 1 addition & 0 deletions components/prompt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Prompt"
description: "Display pre-built AI prompts with one-click copy and Cursor integration buttons so users can quickly use prompts in their AI tools."
keywords: ["prompt", "AI", "cursor", "copy", "prompt card"]
boost: 3
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 1 addition & 0 deletions components/steps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Steps"
description: "Create numbered step-by-step procedures with the steps component to guide users through sequential tasks, tutorials, and setup workflows."
keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"]
boost: 3
---

import IconsOptional from "/snippets/icons-optional.mdx";
Expand Down
1 change: 1 addition & 0 deletions components/tabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Tabs"
description: "Use the tab component to organize content into switchable panels for showing different options, platform versions, or language examples."
keywords: ["tabbed content", "content panels", "switchable content"]
boost: 3
---

Use tabs to organize content into multiple panels that users can switch between. You can add any number of tabs and include other components inside each tab.
Expand Down Expand Up @@ -82,7 +83,7 @@
</ResponseField>

<ResponseField name="borderBottom" type="boolean">
Adds a bottom border and padding to the tabs container. Useful to visually separate tabbed content from the rest of the page, especially when tabs contain content of varying lengths.

Check warning on line 86 in components/tabs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tabs.mdx#L86

Use 'REST' instead of 'rest'.
</ResponseField>

## Tab properties
Expand Down
1 change: 1 addition & 0 deletions components/tiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Tiles"
description: "Use the tiles component to display visual previews with image thumbnails, titles, and descriptions in a responsive grid layout for your docs."
keywords: ["tiles", "visual preview", "grid", "showcase"]
boost: 3
---

Use tiles to create visual showcase elements with a patterned background, title, and description. Tiles are ideal for displaying component previews, feature highlights, or navigation items in a grid layout.
Expand Down Expand Up @@ -57,7 +58,7 @@
## Properties

<ResponseField name="href" type="string" required>
URL to navigate to when the tile is clicked.

Check warning on line 61 in components/tiles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tiles.mdx#L61

In general, use active voice instead of passive voice ('is clicked').
</ResponseField>

<ResponseField name="title" type="string">
Expand Down
1 change: 1 addition & 0 deletions components/tooltips.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Tooltips"
description: "Add tooltips to display contextual definitions and explanations when users hover over terms, abbreviations, or technical concepts in your documentation."
keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"]
boost: 3
---

Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links.
Expand Down
1 change: 1 addition & 0 deletions components/tree.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Tree"
description: "Use the tree component to display hierarchical file and folder structures with collapsible nodes and syntax highlighting for path names."
keywords: ["tree", "file tree", "folder structure", "hierarchical navigation", "file system"]
boost: 3
---

Use tree components to display hierarchical structures like file systems, project directories, or nested content. The tree component supports keyboard navigation and accessibility features.
Expand All @@ -27,9 +28,9 @@
<Tree.Folder name="app" defaultOpen>
<Tree.File name="layout.tsx" />
<Tree.File name="page.tsx" />
<Tree.File name="global.css" />

Check warning on line 31 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L31

'Tree.File' should use sentence-style capitalization.

Check warning on line 31 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L31

'e.F' should have one space.
</Tree.Folder>
<Tree.Folder name="lib">

Check warning on line 33 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L33

'Tree.Folder' should use sentence-style capitalization.

Check warning on line 33 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L33

'e.F' should have one space.
<Tree.File name="utils.ts" />
<Tree.File name="db.ts" />
</Tree.Folder>
Expand Down Expand Up @@ -104,11 +105,11 @@
</ResponseField>

<ResponseField name="defaultOpen" type="boolean" default="false">
Whether the folder is expanded by default.

Check warning on line 108 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L108

In general, use active voice instead of passive voice ('is expanded').
</ResponseField>

<ResponseField name="openable" type="boolean" default="true">
Whether the folder can be opened and closed. Set to false for non-interactive folders.

Check warning on line 112 in components/tree.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/tree.mdx#L112

In general, use active voice instead of passive voice ('be opened').
</ResponseField>

### Tree.File
Expand Down
1 change: 1 addition & 0 deletions components/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Update"
description: "Use the update component to display product updates, release notes, and changelog entries in a structured timeline format with dates."
keywords: ["changelogs", "product updates", "release notes"]
boost: 3
---

Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting.
Expand Down
1 change: 1 addition & 0 deletions components/view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "View"
description: "Use the view component to create switchable content panels for different programming languages, frameworks, or configuration alternatives."
keywords: ["selector", "language-specific content", "content switching"]
boost: 3
---

Use the `View` component to create content that changes based on the selected view in a multi-view dropdown. This is particularly useful for showing code examples or documentation specific to different programming languages or frameworks.
Expand All @@ -11,7 +12,7 @@
</Tip>

<View title="JavaScript" icon="js">
This content is only visible when JavaScript is selected.

Check warning on line 15 in components/view.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/view.mdx#L15

In general, use active voice instead of passive voice ('is selected').

```javascript
console.log("Hello from JavaScript!");
Expand All @@ -19,7 +20,7 @@
</View>

<View title="Python" icon="python">
This content is only visible when Python is selected.

Check warning on line 23 in components/view.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/view.mdx#L23

In general, use active voice instead of passive voice ('is selected').

```python
print("Hello from Python!")
Expand All @@ -38,7 +39,7 @@
</View>

<View title="Python" icon="python">
This content is only visible when Python is selected.

Check warning on line 42 in components/view.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/view.mdx#L42

In general, use active voice instead of passive voice ('is selected').

```python
print("Hello from Python!")
Expand Down
1 change: 1 addition & 0 deletions components/visibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Visibility"
description: "Use the visibility component to show different content to humans on the web UI and to AI agents in Markdown output for conditional rendering."
keywords: ["visibility", "agents", "humans", "markdown", "AI", "conditional content"]
boost: 3
---

Use the `Visibility` component to show different content to humans reading your site versus AI agents processing the Markdown output. This lets you customize information for each audience without maintaining separate pages.
Expand All @@ -24,7 +25,7 @@
</Visibility>

<Visibility for="agents">
> You are viewing this content **in markdown**.

Check warning on line 28 in components/visibility.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/visibility.mdx#L28

Use 'Markdown' instead of 'markdown'.
>
> This content only appears on the Markdown version of pages.
>
Expand Down
1 change: 1 addition & 0 deletions create/changelogs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Changelogs"
description: "Create product changelogs with date-based entries, RSS feed support, and subscriber notifications to keep users informed about updates."
keywords: ["product updates", "release notes", "RSS"]
boost: 3
---

Create a changelog for your docs by adding [Update components](/components/update) to a page.
Expand Down Expand Up @@ -98,7 +99,7 @@
Using `custom`, `center`, or `wide` page modes hides the table of contents and changelog filters. Learn more about [page modes](/organize/pages#page-mode).
</Tip>

### Subscribable changelogs

Check warning on line 102 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L102

Use 'subscribable' instead of 'Subscribable'.

Check warning on line 102 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L102

'Subscribable changelogs' should use sentence-style capitalization.

<Note>RSS feeds are only available on public documentation.</Note>

Expand Down
1 change: 1 addition & 0 deletions create/files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Files"
description: "Serve static assets like images, videos, PDFs, and data files from your documentation repository with automatic optimization and CDN delivery."
keywords: ["static assets","supported file types"]
boost: 3
---

Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`.
Expand All @@ -22,7 +23,7 @@
- **Video**: `.mp4`, `.webm`
- **Audio**: `.mp3`, `.wav`
- **Data**: `.json`, `.yaml`
- **Stylesheets**: `.css`

Check warning on line 26 in create/files.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/files.mdx#L26

Use 'stylesheets?' instead of 'Stylesheets'.
- **Scripts**: `.js`
- **Fonts**: `.woff`, `.woff2`, `.ttf`, `.eot`

Expand All @@ -48,3 +49,3 @@
|- demo-video.mp4
```

Expand Down
1 change: 1 addition & 0 deletions create/redirects.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Redirects"
description: "Configure URL redirects in docs.json for moved, renamed, or deleted documentation pages to preserve SEO rankings and prevent broken links."

Check warning on line 3 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["redirects"]
boost: 3
---

When you change the path of a file in your docs folder, it also changes the URL path to that page. This may happen when restructuring your docs or changing the sidebar title.
Expand Down
1 change: 1 addition & 0 deletions customize/fonts.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Fonts"
description: "Customize typography on your documentation site with Google Fonts or self-hosted font files for headings, body text, and code blocks."

Check warning on line 3 in customize/fonts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/fonts.mdx#L3

'Google Fonts' should use sentence-style capitalization.
keywords: ["Google Fonts", "local fonts", "custom typography"]
boost: 3
---

Set a custom font for your entire site or separately for headings and body text. Use Google Fonts, local font files, or externally hosted fonts. The default font varies by theme.
Expand Down
1 change: 1 addition & 0 deletions customize/react-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "React"
description: "Build interactive and reusable elements with custom React components in your Mintlify documentation using JSX, state, and client-side logic."
keywords: ["React components", "interactive components", "JSX", "custom components"]
boost: 3
---

import { ColorGenerator } from "/snippets/color-generator.jsx";
Expand Down
1 change: 1 addition & 0 deletions customize/themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
description: "Choose and configure a theme to customize your documentation site's colors, dark mode behavior, layout style, and overall visual appearance."
mode: "frame"
keywords: ["theme selection", "Mint", "Maple", "Palm", "Willow", "Linden", "Almond", "Aspen", "Sequoia", "customize appearance"]
boost: 3
---

export const ThemeCard = ({ title, value, description, href }) => {
Expand All @@ -27,13 +28,13 @@
</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 />

Expand Down
1 change: 1 addition & 0 deletions dashboard/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Roles"
description: "Assign admin, editor, or viewer roles to team members to control access levels, editing permissions, and deployment capabilities in Mintlify."
keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions"]
boost: 3
---

<Info>
Expand Down
1 change: 1 addition & 0 deletions deploy/cloudflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Cloudflare"
description: "Deploy your Mintlify documentation at a subpath on your domain using Cloudflare Workers with step-by-step setup and DNS configuration."
keywords: ["Cloudflare Workers", "subpath routing", "reverse proxy setup", "Worker configuration"]
boost: 3
---

import Propagating from "/snippets/custom-subpath-propagating.mdx";
Expand All @@ -9,7 +10,7 @@
To host your documentation at a subpath such as `yoursite.com/docs` using Cloudflare, you must create and configure a Cloudflare Worker.

<Info>
Before you begin, you need a Cloudflare account and a domain name (can be managed on or off Cloudflare).

Check warning on line 13 in deploy/cloudflare.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/cloudflare.mdx#L13

In general, use active voice instead of passive voice ('be managed').
</Info>

## Set up a worker
Expand Down Expand Up @@ -112,7 +113,7 @@

### Resolve DNS conflicts

If your domain already points to another service, you must remove the existing DNS record. Your Cloudflare Worker must be configured to control all traffic for your domain.

Check warning on line 116 in deploy/cloudflare.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/cloudflare.mdx#L116

In general, use active voice instead of passive voice ('be configured').

1. Delete the existing DNS record for your domain. See [Delete DNS records](https://developers.cloudflare.com/dns/manage-dns-records/how-to/create-dns-records/#delete-dns-records) in the Cloudflare documentation for more information.
2. Return to your Worker and add your custom domain.
Expand All @@ -121,7 +122,7 @@
If you use Webflow to host your main site and want to serve Mintlify docs at `/docs` on the same domain, you'll need to configure custom routing through Cloudflare Workers to proxy all non-docs traffic to your main site.

<Warning>
Make sure your main site is set up on a landing page before deploying this Worker, or visitors to your main site may see errors.

Check warning on line 125 in deploy/cloudflare.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/cloudflare.mdx#L125

In general, use active voice instead of passive voice ('is set').
</Warning>

1. In Webflow, set up a landing page for your main site like `landing.yoursite.com`. This is the page that visitors see when they visit your site.
Expand Down
1 change: 1 addition & 0 deletions deploy/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Deployments"
description: "Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, and troubleshooting."
keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"]
boost: 3
---

Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected.
Expand Down Expand Up @@ -34,7 +35,7 @@
Go to the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in the settings page of your dashboard.
</Step>
<Step title="Delete the deployment.">
1. In the **Delete my deployment** section, provide a reason for deletion.

Check warning on line 38 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L38

Avoid first-person pronouns such as 'my'.
2. Click the delete button and confirm that you want to delete the deployment.
</Step>
</Steps>
Expand All @@ -43,4 +44,4 @@
Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period.
</Warning>

If you have multiple deployments, you'll be redirected to another deployment after deletion. If you delete your only deployment, you'll be redirected to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion.

Check warning on line 47 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L47

In general, use active voice instead of passive voice ('be redirected').

Check warning on line 47 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L47

In general, use active voice instead of passive voice ('be redirected').
1 change: 1 addition & 0 deletions deploy/docs-subpath.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Overview"
description: "Host your Mintlify documentation at a /docs subpath on your main domain using Cloudflare Workers, Vercel rewrites, or an nginx reverse proxy."
keywords: ["subpath routing", "/docs setup"]
boost: 3
---

Host your documentation at a subpath like `your-domain.com/docs` to keep your docs on your main domain, which makes them easier to find and maintains a cohesive brand experience for your users.
Expand Down
1 change: 1 addition & 0 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "GitHub"
description: "Connect your GitHub repository to Mintlify for automated deployments, pull request preview builds, and continuous documentation synchronization."
keywords: ["GitHub App","repository connection","automated deployments"]
boost: 3
---

Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.
Expand Down Expand Up @@ -52,7 +53,7 @@

After completing either path, install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app).

## Install the GitHub App

Check warning on line 56 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L56

'Install the GitHub App' should use sentence-style capitalization.

<Note>
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
Expand Down Expand Up @@ -126,7 +127,7 @@
</Accordion>
</AccordionGroup>

### GitHub App connection issues

Check warning on line 130 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L130

'GitHub App connection issues' should use sentence-style capitalization.

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

Expand All @@ -143,7 +144,7 @@

### Feedback add-ons are unavailable

The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility.

Check warning on line 147 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L147

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

If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings.

Expand Down
1 change: 1 addition & 0 deletions deploy/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "GitLab"
description: "Connect your GitLab repository to Mintlify for automated documentation deployments, merge request previews, and continuous synchronization."
keywords: ["GitLab integration", "access tokens", "merge request previews", "self-hosted", "instance"]
boost: 3
---

Mintlify uses access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify.
Expand Down
1 change: 1 addition & 0 deletions deploy/vercel.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: "Vercel"
description: "Configure Vercel rewrites to serve your Mintlify documentation at a subpath on your main domain with step-by-step vercel.json setup."

Check warning on line 3 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"]
boost: 3
---

import { VercelJsonGenerator } from "/snippets/vercel-json-generator.mdx";

Configure your `vercel.json` file to proxy requests from your main domain to your documentation at a subpath.

## vercel.json file

Check warning on line 12 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L12

'vercel.json file' should use sentence-style capitalization.

Check warning on line 12 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L12

Use 'JSON' instead of 'json'.

The `vercel.json` file configures how your project builds and deploys. It sits in your project's root directory and controls various aspects of your deployment, including routing, redirects, headers, and build settings.

Expand All @@ -28,7 +29,7 @@
</Frame>
3. Enter your domain.
4. Select **Add domain**.
5. Add the following rewrites to your `vercel.json` file. Replace `[subdomain]` with your subdomain, which is found at the end of your dashboard URL. For example, `dashboard.mintlify.com/your-organization/your-subdomain` has a domain identifier of `your-subdomain`.

Check warning on line 32 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L32

In general, use active voice instead of passive voice ('is found').

```json
{
Expand All @@ -55,7 +56,7 @@

### Host at custom subpath

To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if your documentation is hosted at `yoursite.com/help`, your documentation files must be in a `help/` directory.

Check warning on line 59 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L59

In general, use active voice instead of passive voice ('is hosted').

Use the generator below to create your rewrites configuration. Add the rewrites to your `vercel.json` file.

Expand Down
1 change: 1 addition & 0 deletions editor/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Configurations"
description: "Edit site branding, colors, appearance, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync."
keywords: ["editor", "configurations", "settings", "branding", "theme"]
boost: 3
---

Configure your documentation site's branding, appearance, and features from the **Configurations** panel in the web editor. Configuration changes sync in real-time with other editors on the same branch, so your team always sees the latest settings.
Expand Down Expand Up @@ -74,7 +75,7 @@
- **Thumbnail background**: Set a custom background image for page thumbnails and social previews.
- **Thumbnail appearance**: Control how thumbnails display.
- **Thumbnail font**: Set a custom font for text in thumbnails.
- **Page eyebrow**: Add small labels above page titles.

Check warning on line 78 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L78

Use 'preceding' instead of 'above'.
- **Code block theme**: Choose the syntax highlighting theme for code blocks.
- **LaTeX support**: Enable mathematical notation rendering with LaTeX.
- **Icon library**: Choose the icon library to use for your site.
Expand All @@ -83,7 +84,7 @@

Customize the search experience.

- **Search placeholder**: The text that appears in the search box before users type. Default is "Search or ask...".

Check warning on line 87 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L87

Commas and periods go inside quotation marks.

Check warning on line 87 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L87

In general, don't use an ellipsis.

## Connect integrations

Expand Down
1 change: 1 addition & 0 deletions guides/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Guides"
description: "Browse guides on documentation best practices, content strategy, SEO optimization, accessibility, and docs-as-code workflows for your team."
boost: 3
---

The guides in this section contain advice for creating documentation that helps your users succeed. Whether you're starting from scratch or improving existing docs, these guides help you plan, write, and maintain your documentation.
Expand Down
1 change: 1 addition & 0 deletions index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
description: "Mintlify is an AI-native documentation platform built for developers, with beautiful defaults, interactive API playgrounds, and smart search."
mode: "frame"
keywords: ["overview", "platform", "getting started", "features"]
boost: 3
---

export const HeroCard = ({ filename, title, description, href }) => {
return (
<a className="group cursor-pointer pb-8" href={href}>

Check warning on line 11 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L11

Use 'classnames?' instead of 'className'.
<img
src={`https://raw.githubusercontent.com/mintlify/docs/refs/heads/main/images/hero/${filename}.png`}

Check warning on line 13 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L13

Use 'PNG' instead of 'png'.
className="block dark:hidden pointer-events-none group-hover:scale-105 transition-all duration-100"
/>
<img
Expand All @@ -21,8 +22,8 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

Check warning on line 25 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L25

Use semicolons judiciously.
};

Check warning on line 26 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L26

Use semicolons judiciously.

<div className="relative">
<div className="absolute -top-14 left-0 right-0 opacity-80">
Expand Down
1 change: 1 addition & 0 deletions integrations/analytics/amplitude.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Amplitude"
description: "Integrate Amplitude analytics with your Mintlify documentation site to track user behavior, page views, and content engagement metrics."
keywords: ["Amplitude integration", "Amplitude API key", "user behavior tracking", "product analytics"]
boost: 3
---

Add the following to your `docs.json` file to send analytics to Amplitude.
Expand Down
Loading
Loading