Skip to content
Open
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
2 changes: 1 addition & 1 deletion .mintlify-agent-context.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"schemaVersion": 1,
"sourceRepository": "mintlify/docs",
"sourcePath": "agent-context",
"sourceCommit": "4ba740259e025e8c1f110976df094c68d579a5f0",
"sourceCommit": "f3765243682244e03d7db3a45c70a12964e465aa",
"target": "cursor"
}
2 changes: 1 addition & 1 deletion skills/mintlify/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ keywords: ["relevant", "search", "terms"]
| `title` | string | Page title in navigation and browser tabs. Auto-generated from the path if omitted. |
| `description` | string | Brief description for SEO. Displays under the title. |
| `sidebarTitle` | string | Short title for sidebar navigation. |
| `icon` | string | Lucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path. |
| `icon` | string | Lucide, Font Awesome, or Tabler icon name. Also accepts a single emoji, a URL, or a file path. |
| `tag` | string | Label next to page title in sidebar (e.g., "NEW"). |
| `hidden` | boolean | Remove from sidebar. Page still accessible by URL. |
| `mode` | string | Page layout: `default`, `wide`, `custom`, `frame`, `center`. |
Expand Down
2 changes: 1 addition & 1 deletion skills/mintlify/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Available on all commands.

- `mint broken-links` — Check for broken internal links. `--files <paths...>` limits the check to specific files or globs. `--check-anchors` validates `#` anchors. `--check-external` checks external URLs. `--check-redirects` checks that redirect destinations in `docs.json` resolve. `--check-snippets` checks links inside `<Snippet>` components.
- `mint a11y` — Accessibility checks (alt text, color contrast). `--skip-contrast` or `--skip-alt-text` to narrow scope.
- `mint test` — Scan content for code blocks and generate unit tests that validate them. Interactive; only pages in the `docs.json` navigation appear for selection. Writes generated test projects to `tests/mint-test/<run-id>/` and run reports/history to `.mintlify/test/`. Add both paths to `.gitignore` to avoid committing test artifacts.
- `mint test` — Scan content for code blocks and generate unit tests that validate them. Requires `mint login`. Interactive; only pages in the `docs.json` navigation appear for selection. Writes generated test projects to `tests/mint-test/<run-id>/` and run reports/history to `.mintlify/test/`. Add both paths to `.gitignore` to avoid committing test artifacts. When a previous run report exists, the next interactive run offers **Update tests** (rerun the same pages with the same agent and model), **Review last test run** (browse saved results without running anything), or **Start a brand new test** (pick an agent and pages from scratch).
- `mint score [url]` — Score a docs site's AI/agent readiness. Checks llms.txt, MCP discoverability, robots.txt, sitemap, structured data, response latency, and more. Requires `mint login`. Defaults to your configured subdomain. `--format` accepts `table` (default), `plain`, or `json`.
- `mint format` — Format every `.mdx` file in the current directory and its subdirectories in place. Respects `.gitignore` and Mintlify ignore rules. Commit or stash changes first so you can review the rewrite.

Expand Down
4 changes: 2 additions & 2 deletions skills/mintlify/reference/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,10 +323,10 @@ Text with <Icon icon="check" iconType="solid" /> inline icon.
```

Props:
- `icon` (string, required): Icon name, URL, or file path.
- `icon` (string, required): Font Awesome, Lucide, or Tabler icon name, a single emoji, a URL, or a file path.
- `iconType` (string): Font Awesome style.
- `size` (number): Pixel size.
- `color` (string): Hex color.
- `color` (string): Hex color. Not applied to emoji icons.

## Tooltips

Expand Down
27 changes: 24 additions & 3 deletions skills/mintlify/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The SKILL.md file lists common frontmatter fields. Here is the complete set. All
| `title` | string | Page title in navigation and browser tabs. Auto-generated from the path if omitted. |
| `description` | string | Brief description for SEO. Displays under the title. |
| `sidebarTitle` | string | Short title for sidebar navigation. |
| `icon` | string | Lucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path. |
| `icon` | string | Lucide, Font Awesome, or Tabler icon name. Also accepts a single emoji, a URL, or a file path. |
| `iconType` | string | Font Awesome icon style: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`. |
| `tag` | string | Label next to page title in sidebar (e.g., "NEW"). |
| `hidden` | boolean | Remove from sidebar. Page still accessible by URL. Also excludes the page from search, sitemaps, external indexing, AI context, and `llms.txt`. Remove the field (or set `false`) to make a page visible again. |
Expand Down Expand Up @@ -180,7 +180,7 @@ Single file or light/dark variants:
}
```

Options: `"fontawesome"` (default), `"lucide"`, or `"tabler"`. You can only use one library per project. Individual icons can still use URLs or file paths regardless of this setting.
Options: `"fontawesome"` (default), `"lucide"`, or `"tabler"`. You can only use one library per project. Individual icons can still use a single emoji, a URL, or a file path regardless of this setting.

## Fonts

Expand Down Expand Up @@ -502,7 +502,7 @@ Controls whether clicking a navigation group navigates to its first page (`true`

## Reusable snippets

Store reusable content in the `/snippets/` directory.
Store reusable content in the `/snippets/` directory. Snippet files must be `.mdx`, `.md`, `.js`, or `.jsx`. You cannot import `.json` or `.yaml` files directly. Keep data in a `.js` snippet with a named export, or generate one from a JSON or YAML source.

### MDX snippets

Expand Down Expand Up @@ -547,6 +547,27 @@ import { Counter } from "/snippets/counter.jsx";

JSX components can live in any directory, not just `/snippets/`. Nested imports between snippet files are not supported.

### Data snippets

Export structured data from a `.js` snippet and render it with a `.jsx` snippet to keep tables, lists, or cards in sync across pages.

```js
// snippets/sdk-components.js
export const sdkComponents = [
{ name: "CardForm", version: "2.4.0", status: "Stable" },
{ name: "PinReveal", version: "1.9.2", status: "Beta" }
];
```

```mdx
import { sdkComponents } from "/snippets/sdk-components.js";
import { ComponentsTable } from "/snippets/components-table.jsx";

<ComponentsTable rows={sdkComponents} />
```

MDX expressions (imported variables like `{myName}` and inline expressions like `{1 + 1}`) are evaluated client-side. Their values are absent from a page's initial HTML and from offline exports. Crawlers, LLMs, and other tools that do not run JavaScript do not see them. Write values as plain text when they must be visible in those situations.

## Hidden pages

Set `hidden: true` in frontmatter to remove from sidebar. Page remains accessible by URL.
Expand Down
1 change: 1 addition & 0 deletions skills/mintlify/reference/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ Version properties:
- `version` (required): Version label shown in the selector.
- `default`: Set `true` to make this the default version (otherwise the first entry is the default).
- `tag`: Badge label displayed in the version selector dropdown (e.g., `"Latest"`, `"Recommended"`, `"Beta"`).
- `hidden`: Set `true` to remove this version from the selector and exclude every page beneath it from site search, sitemaps, search engine indexing, and AI context. `navigation.tabs`, `navigation.anchors`, `navigation.dropdowns`, `navigation.languages`, and `navigation.products` accept the same `hidden` flag with the same effect. Versions do not support `searchable: true`; to keep hidden versions discoverable, set `seo.indexing: "all"` in `docs.json`.

## Languages

Expand Down