Mintlify

--- name: mintlify description: Comprehensive reference for building Mintlify documentation sites. Use when creating pages, configuring docs.json, adding components, setting up navigation, or working with API references. Routes to detailed reference files for all components and configuration options. license: MIT compatibility: Works with any Mintlify documentation project. Requires docs.json configuration file. metadata: author: Mintlify url: https://mintlify.com version: "0.2" --- # Mintlify reference Reference for building documentation with Mintlify. This file covers essentials that apply to every task. For detailed reference on specific topics, read the files listed in the reference index below. ## Reference index Read these files **only when your task requires them**. They are in the `reference/` directory next to this file. To find them, look in the same directory as this skill file (e.g., `.claude/skills/mintlify/reference/`). | File | When to read | |------|-------------| | `reference/components.md` | Adding or modifying components (callouts, cards, steps, tabs, accordions, code groups, fields, frames, icons, tooltips, badges, trees, mermaid, panels, prompts, colors, tiles, updates, views). | | `reference/configuration.md` | Changing docs.json settings (theme, colors, logo, fonts, appearance, navbar, footer, banner, redirects, SEO, integrations, API config). Also covers snippets, hidden pages, .mintignore, custom CSS/JS, and the complete frontmatter fields table. | | `reference/navigation.md` | Modifying site navigation structure (groups, tabs, anchors, dropdowns, products, versions, languages, OpenAPI in nav). | | `reference/api-docs.md` | Setting up API documentation (OpenAPI, AsyncAPI, MDX manual API pages, extensions, playground config). | ## Before you start Read the project's `docs.json` file first. It defines the site's navigation, theme, colors, and configuration. Search for existing content before creating new pages. You may need to update an existing page, add a section, or link to existing content rather than duplicating. Read 2-3 similar pages to match the site's voice, structure, and formatting. ## File format Mintlify uses MDX files (`.mdx` or `.md`) with YAML frontmatter. ``` project/ ├── docs.json # Site configuration (required) ├── index.mdx ├── quickstart.mdx ├── guides/ │ └── example.mdx ├── openapi.yml # API specification (optional) ├── images/ # Static assets │ └── example.png └── snippets/ # Reusable components └── component.jsx ``` ### File naming - Match existing patterns in the directory - If no existing files or mixed file naming patterns, use kebab-case: `getting-started.mdx` - Add new pages to `docs.json` navigation or they won't appear in the sidebar ### Internal links - Use root-relative paths without file extensions: `/getting-started/quickstart` - Do not use relative paths (`../`) or absolute URLs for internal pages ### Images Store images in an `images/` directory. Reference with root-relative paths. All images require descriptive alt text. ```mdx  ``` ## Page frontmatter Every page requires `title` in its frontmatter. Include `description` and `keywords` for SEO. ```yaml --- title: "Clear, descriptive title" description: "Concise summary for SEO and navigation." keywords: ["relevant", "search", "terms"] --- ``` ### Common frontmatter fields | Field | Type | Required | Description | |-------|------|----------|-------------| | `title` | string | Yes | Page title in navigation and browser tabs. | | `description` | string | No | Brief description for SEO. Displays under the title. | | `sidebarTitle` | string | No | Short title for sidebar navigation. | | `icon` | string | No | Lucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path. | | `tag` | string | No | Label next to page title in sidebar (e.g., "NEW"). | | `hidden` | boolean | No | Remove from sidebar. Page still accessible by URL. | | `mode` | string | No | Page layout: `default`, `wide`, `custom`, `frame`, `center`. | | `keywords` | array | No | Search terms for internal search and SEO. | | `api` | string | No | API endpoint for interactive playground (e.g., `"POST /users"`). | | `openapi` | string | No | OpenAPI endpoint reference (e.g., `"GET /endpoint"`). | ## Quick component reference Below are the most commonly used components. For full props and all 24 components, read `reference/components.md`. ### Callouts ```mdx Supplementary information, safe to skip. Helpful context such as permissions or prerequisites. Recommendations or best practices. Potentially destructive actions or important caveats. Success confirmation or completed status. Critical warnings about data loss or breaking changes. ``` ### Steps ```mdx Instructions for step one. Instructions for step two. ``` ### Tabs and code groups ```mdx ```bash npm install package-name ``` ```bash yarn add package-name ``` ``` ```mdx ```javascript example.js const greeting = "Hello, world!"; ``` ```python example.py greeting = "Hello, world!" ``` ``` ### Cards and columns ```mdx Card description text. Card description text. ``` Use `` to arrange cards (or other content) in a grid. `cols` accepts 1-4. ### Accordions ```mdx Content one. Content two. ``` ## CLI commands - `npm i -g mint` — Install the Mintlify CLI. - `mint dev` — Local preview at localhost:3000. - `mint broken-links` — Check internal links. - `mint a11y` — Check for accessibility issues. - `mint validate` — Validate documentation builds. - `mint upgrade` — Upgrade from `mint.json` to `docs.json`. ## Writing standards - Second-person voice ("you"). - Active voice, direct language. - Sentence case for headings ("Getting started", not "Getting Started"). - Sentence case for code block titles. - All code blocks must have language tags. - All images must have descriptive alt text. - No marketing language, filler phrases, or emoji. - Keep code examples simple, practical, and tested. ## Common mistakes - Missing language tag on a code block (use ` ```python `, not ` ``` `). - Using relative paths (`../page`) instead of root-relative (`/section/page`). - Forgetting to add new pages to `docs.json` navigation. - Images without alt text. - Adding file extensions to internal links (`/page.mdx` instead of `/page`).