mintlify
Installation
SKILL.md
Mintlify reference
Reference for working on Mintlify projects. 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.
| 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, MDX, panels, prompts, colors, tiles, updates, views). Also covers table column widths. |
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, and SDK references in nav). |
reference/api-docs.md |
Setting up API documentation (OpenAPI, AsyncAPI, MDX manual API pages, extensions, playground config). |
reference/cli.md |
Running common CLI commands (dev, validate, add-domain, analytics, score, broken-links, a11y, format, and config) and their key flags. |
reference/product-context.md |
Before substantial content work (new site, broad restructure, first-time section setup) — check for and maintain .mintlify/product-brief.md. |