mintlify

The Mintlify skill empowers agents to build, structure, and maintain high-quality documentation websites using the Mintlify platform. It is designed for developers, technical writers, and product teams aiming to transform MDX content into professional, searchable documentation sites. The skill manages the end-to-end documentation lifecycle, from initial configuration to content organization and deployment readiness.

• Site Configuration: Manage site-wide settings via the docs.json schema, including theme customization, branding, colors, and global integrations.
• Navigation Strategy: Implement complex site hierarchies, including groups, tabs, anchors, dropdowns, product-specific segments, versioning, and multi-language support.
• Content Authoring: Process MDX pages with YAML frontmatter, utilizing specialized Mintlify components for improved readability.
• UI/UX Components: Leverage built-in components such as Accordions, Tabs, Steps, CodeGroups, Callouts (Note, Info, Tip, Warning, Check), and API-specific fields like ParamField and ResponseField.
• API Documentation: Streamline the integration of OpenAPI specifications into the documentation site to auto-generate interactive API references.
• Asset Management: Coordinate internal linking, image pathing, and static asset management within the project structure.
• CLI Automation: Perform essential maintenance tasks using the Mintlify CLI, including validation, link checking (broken-links), and accessibility audits (a11y).

Usage Notes and Constraints:

• Always reference the official mintlify.com/docs for the latest component syntax and configuration schemas.
• Prioritize the built-in component library over custom CSS to ensure consistent platform behavior.
• Favor the docs.json file for structural changes before resorting to custom.css for layout overrides.
• Ensure all API references are linked via properly configured openapi.yml files to maintain sync with the backend implementation.
• For large-scale documentation, use snippets for reusable content, but avoid over-parameterization to keep the codebase maintainable.
• The skill requires a Node.js environment to execute CLI commands such as mint dev, mint validate, and mint rename.