mintlify

Create and maintain Mintlify documentation sites with docs.json and MDX.

18|Updated Jul 23, 2025
One-click install
npx skills add https://github.com/faw01/create-mf2-app --skill mintlify-faw01
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/faw01/create-mf2-app/tree/main/apps/cli/template/.agents/skills/mintlify
Command: npx skills add https://github.com/faw01/create-mf2-app --skill mintlify-faw01

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill addresses the complexity of maintaining high-quality, consistent documentation sites by providing a structured framework for content creation, site configuration, and API reference management.

Core Features & Use Cases

  • Site Configuration: Manage navigation, themes, and integrations through a centralized docs.json file.
  • Content Management: Utilize MDX-based authoring with built-in components like callouts, tabs, and steps to create engaging documentation.
  • API Documentation: Automatically generate endpoint pages from OpenAPI specifications or manually define them for full control.

Quick Start

Use the mintlify skill to initialize a new documentation page with the required title and description frontmatter.

Frequently Asked Questions about mintlify

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a documentation site using Mintlify?

To create a documentation site with Mintlify, you configure site settings, navigation, and themes through a centralized docs.json file, then author content pages using MDX with standardized frontmatter for metadata like title and description.

How does Mintlify generate API references from OpenAPI specifications?

Mintlify generates API references by automatically creating endpoint pages from OpenAPI specifications, or you can manually define them to maintain full control over your API documentation structure and output.

What's the best way to structure navigation for a static documentation site?

The best way to structure navigation for a static documentation site is by managing it centrally through the Mintlify docs.json configuration file, which handles themes, integrations, and page grouping.

Can I use built-in components like tabs and callouts in MDX documentation?

Yes, you can use built-in components like callouts, tabs, and steps in MDX documentation to create engaging, interactive content that adheres to Mintlify best practices for technical writing.

Do I need standardized frontmatter for every Mintlify documentation page?

Yes, standardized MDX frontmatter is required for every Mintlify documentation page to define essential page metadata, specifically requiring a title and description to initialize the page correctly.

Why use Mintlify over other static site generators for technical writing?

Mintlify streamlines technical writing by providing a structured framework for content management and API reference generation, reducing the complexity of maintaining high-quality, consistent documentation sites compared to other static site generators.