From 1fc6385f04781676638b07ce3499d631e316d747 Mon Sep 17 00:00:00 2001 From: "mintlify-agent-context-sync[bot]" Date: Wed, 16 Sep 2026 18:25:01 +0000 Subject: [PATCH] Sync Mintlify agent context --- .mintlify-agent-context.json | 2 +- skills/mintlify/SKILL.md | 2 +- skills/mintlify/reference/cli.md | 2 +- skills/mintlify/reference/components.md | 4 ++-- skills/mintlify/reference/configuration.md | 27 +++++++++++++++++++--- skills/mintlify/reference/navigation.md | 1 + 6 files changed, 30 insertions(+), 8 deletions(-) diff --git a/.mintlify-agent-context.json b/.mintlify-agent-context.json index b403469..c37428c 100644 --- a/.mintlify-agent-context.json +++ b/.mintlify-agent-context.json @@ -2,6 +2,6 @@ "schemaVersion": 1, "sourceRepository": "mintlify/docs", "sourcePath": "agent-context", - "sourceCommit": "4ba740259e025e8c1f110976df094c68d579a5f0", + "sourceCommit": "f3765243682244e03d7db3a45c70a12964e465aa", "target": "cursor" } diff --git a/skills/mintlify/SKILL.md b/skills/mintlify/SKILL.md index 202d902..5a98f66 100644 --- a/skills/mintlify/SKILL.md +++ b/skills/mintlify/SKILL.md @@ -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`. | diff --git a/skills/mintlify/reference/cli.md b/skills/mintlify/reference/cli.md index d922665..2e32107 100644 --- a/skills/mintlify/reference/cli.md +++ b/skills/mintlify/reference/cli.md @@ -24,7 +24,7 @@ Available on all commands. - `mint broken-links` — Check for broken internal links. `--files ` 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 `` 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//` 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//` 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. diff --git a/skills/mintlify/reference/components.md b/skills/mintlify/reference/components.md index 738467a..4fb17dc 100644 --- a/skills/mintlify/reference/components.md +++ b/skills/mintlify/reference/components.md @@ -323,10 +323,10 @@ Text with 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 diff --git a/skills/mintlify/reference/configuration.md b/skills/mintlify/reference/configuration.md index b8ccc7b..fbe0477 100644 --- a/skills/mintlify/reference/configuration.md +++ b/skills/mintlify/reference/configuration.md @@ -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. | @@ -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 @@ -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 @@ -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"; + + +``` + +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. diff --git a/skills/mintlify/reference/navigation.md b/skills/mintlify/reference/navigation.md index b102895..18cd412 100644 --- a/skills/mintlify/reference/navigation.md +++ b/skills/mintlify/reference/navigation.md @@ -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