mintlify

Convert MDX content into structured documentation sites with docs.json navigation.

Updated Mar 12, 2026

Search Tags:#documentation #api reference #mdx #docs.json #mintlify #navigation configuration

Ready to run

npx skills add https://github.com/mpsuesser/workspace --skill mintlify-mpsuesser

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/mpsuesser/workspace/tree/main/dotconfig/pi/agent/skills/__techs__/.unused/mintlify
Command: npx skills add https://github.com/mpsuesser/workspace --skill mintlify-mpsuesser

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify streamlines the creation and maintenance of documentation sites from MDX content, so teams spend less time wrestling with site structure and more time delivering accurate docs.

Core Features & Use Cases

Docs site publishing: Build documentation sites by transforming MDX into a browsable site.
Site-wide configuration: Define navigation, theme, and integrations in docs.json to keep the site consistent.
Content authoring standards: Write MDX pages with page frontmatter (title, description) and follow conventions for links, components, and formatting.
API documentation workflows: Support OpenAPI-driven auto-generated pages or manual endpoint pages when needed.

Quick Start

Use the mintlify skill to guide the creation or update of your documentation by starting from docs.json, then writing an MDX page with 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 convert MDX files into a structured documentation site?▼

You can convert MDX files into a structured documentation site by configuring docs.json for navigation and writing MDX pages with required frontmatter. This process transforms content into a browsable website following Mintlify best practices.

What is the best way to configure navigation for a Mintlify documentation site?▼

Configuring navigation for a Mintlify documentation site is done by defining site-wide settings, theme, and navigation structure within the docs.json file. This ensures the generated documentation site remains consistent and structured.

How do I generate API reference pages from an OpenAPI specification?▼

Generating API reference pages from an OpenAPI specification is supported through auto-generated pages driven by your OpenAPI definition. You can also create manual endpoint pages for API documentation when needed.

Does Mintlify require specific frontmatter for MDX pages?▼

Yes, Mintlify requires MDX pages to include page frontmatter, specifically title and description fields. Following these content authoring standards ensures your documentation meets the required file conventions and best practices.

Can I use root-relative links when authoring MDX documentation content?▼

Yes, you can and should use root-relative internal links when authoring MDX documentation content. Leveraging root-relative links is a Mintlify best practice that ensures correct file conventions across your documentation site.