mintlify

Create MDX documentation sites using Mintlify conventions and CLI validation.

12.6k|1.5k|Updated Feb 3, 2026
One-click install
npx skills add https://github.com/nearai/ironclaw --skill mintlify-nearai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/nearai/ironclaw/tree/main/.claude/skills/mintlify-docs
Command: npx skills add https://github.com/nearai/ironclaw --skill mintlify-nearai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify helps you create and maintain documentation sites from MDX so you can publish structured, navigable docs without hand-built page layouts.

Core Features & Use Cases

  • Site configuration with docs.json: Define navigation, theme, and integrations centrally.
  • MDX-based documentation pages: Author content with page-level YAML frontmatter (including titles and SEO descriptions).
  • API documentation support: Generate docs from an OpenAPI spec or document endpoints manually when needed.
  • Quality and reliability tooling: Validate builds, check broken links, and run accessibility checks.

Quick Start

Use the mintlify skill to create or update an MDX documentation page for your project by following the docs.json navigation structure and adding required frontmatter fields like title and description.

Frequently Asked Questions about mintlify

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

FAQPage Schema
How do I convert MDX files into a documentation site?

To convert MDX files into a documentation site, the Mintlify skill applies Mintlify conventions to configure navigation, theme, and page frontmatter. It reads docs.json first to structure your MDX content into a polished, navigable site without hand-built layouts.

What is the best way to structure navigation for an API reference?

The best way to structure navigation for an API reference is by defining it centrally within a docs.json file. This ensures your API documentation pages are properly linked and organized using root-relative paths throughout the site.

How do I generate API documentation from an OpenAPI spec?

You can generate API documentation from an OpenAPI spec using Mintlify conventions. This allows you to automatically create API reference pages or manually document endpoints when needed, ensuring all pages include required title and description frontmatter.

Why does my Mintlify build fail when validating MDX pages?

Your Mintlify build fails when validating MDX pages if required frontmatter fields like title and description are missing. The Mintlify CLI requires each MDX page to have these fields and uses root-relative paths for internal linking to pass validation checks.

Can I use Mintlify CLI for broken link checking and validation?

Yes, you can use the Mintlify CLI for broken link checking and build validation. It ensures your MDX documentation meets accessibility standards and verifies that internal links using root-relative paths resolve correctly before publishing.

Do I need docs.json to configure a Mintlify site?

Yes, you need docs.json to configure a Mintlify site. The docs.json file is read first to centrally define your navigation, theme, and integrations, establishing the structure required to organize your MDX documentation pages effectively.