| name | ak:mintlify |
| description | Build and maintain Mintlify documentation sites. Covers docs.json, MDX components, navigation, page frontmatter, theming, OpenAPI/AsyncAPI, AI docs assets such as llms.txt and skill.md, deployment targets, and local validation CLI commands. |
| user-invocable | true |
| when_to_use | Invoke for Mintlify docs site structure, MDX, or local checks. |
| category | dev-tools |
| keywords | ["docs-site","API-docs","MDX","Mintlify"] |
| license | MIT |
| argument-hint | [task] [path] |
| metadata | {"author":"agentkit","version":"2.0.0"} |
Mintlify Documentation Builder
Mintlify is a modern documentation platform that transforms Markdown/MDX files into beautiful, interactive documentation sites.
Quick Start
npm i -g mintlify
mint new
mint dev
mint validate
Core Concepts
Configuration: docs.json file defines theme, navigation, branding, colors, integrations.
Themes: 7 options - mint, maple, palm, willow, linden, almond, aspen
Content: MDX files with frontmatter, support for React components and Mintlify-specific components.
Navigation: Tabs, anchors, groups, dropdowns, products, versions, languages (28+ locales).
Components: 26+ built-in components for structure, API documentation, callouts, diagrams, interactivity.
CLI Commands
mint dev
mint new
mint update
mint broken-links
mint a11y
mint validate
mint openapi-check
mint rename <old> <new>
mint migrate-mdx
Key Features
API Documentation: Auto-generate from OpenAPI/AsyncAPI specs, interactive playgrounds, multi-language code examples.
AI Features: llms.txt, skill.md, MCP support, contextual AI menu options, Discord/Slack bots.
Customization: Custom fonts, colors, backgrounds, logos, favicons, page modes (default|wide|custom|frame|center).
Analytics: GA4, PostHog, Amplitude, Clarity, Fathom, Heap, Hotjar, LogRocket, Mixpanel, Plausible, and more.
Deployment: Auto-deploy from GitHub/GitLab, preview deployments, custom domains, subpath hosting, Vercel/Cloudflare/AWS.
Install the package
Set up config
```