t1k:web:content:mintlify
| Field | Value |
|---|---|
| Module | content |
| Version | 1.12.8 |
| Effort | medium |
| Tools | — |
Keywords: developer portal, docs, documentation, knowledge base, MDX, mintlify, OpenAPI
How to invoke
Section titled “How to invoke”/t1k:web:content:mintlify[task] [path]Mintlify Documentation Builder
Section titled “Mintlify Documentation Builder”Mintlify is a modern documentation platform that transforms Markdown/MDX files into beautiful, interactive documentation sites.
Quick Start
Section titled “Quick Start”bun add -g mintmint new # Initialize new docsmint dev # Local previewmint validate # Validate configurationCore Concepts
Section titled “Core Concepts”Configuration: docs.json file defines theme, navigation, branding, colors, integrations.
Themes: 9 options - mint, maple, palm, willow, linden, almond, aspen, sequoia, luma
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
Section titled “CLI Commands”mint dev # Local preview environmentmint new [directory] # Create a new Mintlify documentation sitemint update # Update the CLI to the latest versionmint broken-links # Check for broken linksmint a11y # Check for accessibility issuesmint validate # Validate the docs build (strict — exits on warnings)mint export # Export a static site for air-gapped deploymentmint openapi-check <spec> # DEPRECATED — use `mint validate`; takes one spec (file or URL)mint openapi-check is deprecated in the current CLI (it no longer appears in mint --help
and prints a deprecation warning pointing at mint validate). It still runs, so existing
pipelines keep working — prefer mint validate, which validates the whole build including
OpenAPI references.
Key Features
Section titled “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.
Navigation: Products (partition docs), versions (multiple doc versions), languages (i18n), tabs, menus, anchors.
SEO: Custom metatags, indexing control, redirects, sitemap generation.
Reference Files
Section titled “Reference Files”references/docs-json-configuration-reference.md- Complete docs.json configurationreferences/mdx-components-reference.md- All 26+ MDX componentsreferences/api-documentation-components-reference.md- API docs and OpenAPI integrationreferences/navigation-structure-and-organization-reference.md- Navigation patternsreferences/deployment-and-continuous-integration-reference.md- Deployment and CI/CDreferences/ai-features-and-integrations-reference.md- AI assistant, llms.txt, MCP
Common Patterns
Section titled “Common Patterns”Basic docs.json:
{ "theme": "mint", "name": "My Docs", "colors": { "primary": "#0D9373" }, "navigation": [ { "group": "Getting Started", "pages": ["introduction", "quickstart"] } ]}MDX page with components:
---title: "Getting Started"description: "Quick introduction"---
<Note>Important information</Note>
<CodeGroup>```bashbun installpip installResources
Section titled “Resources”- Official docs: https://mintlify.com/docs
- GitHub: https://github.com/mintlify
- Community: Discord server for support