mintlify

Transform MDX files into Mintlify documentation sites with docs.json configuration.

1|Updated Feb 27, 2026

Search Tags:#documentation #website #frontmatter #mdx #docs.json #mintlify

Ready to run

npx skills add https://github.com/jrmatherly/apollos-portal --skill mintlify-jrmatherly

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/jrmatherly/apollos-portal/tree/main/.claude/skills/mintlify
Command: npx skills add https://github.com/jrmatherly/apollos-portal --skill mintlify-jrmatherly

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify automates the creation and maintenance of documentation sites by transforming MDX content into fully navigable documentation, reducing manual setup and drift.

Core Features & Use Cases

Transform MDX into Mintlify-ready documentation with a configurable docs.json
Use YAML frontmatter to define page metadata and structure
Leverage Mintlify components for consistent, rich documentation and automatic navigation
Integrate OpenAPI or API references and deployment tooling for scalable docs

Quick Start

Install Mintlify, configure docs.json at the project root, and begin authoring MDX pages with YAML frontmatter.

Frequently Asked Questions about mintlify

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

FAQPage Schema

How do I build a documentation site using MDX files with Mintlify?▼

To build a Mintlify documentation site, you configure a docs.json file at your project root and author MDX pages. The system transforms your MDX content into fully navigable documentation using YAML frontmatter for page metadata.

What is the best way to structure navigation for a developer portal using Mintlify?▼

Structuring navigation for a developer portal is handled automatically by Mintlify through your docs.json configuration and the YAML frontmatter defined in each MDX page, ensuring consistent and scalable site architecture.

Can I use YAML frontmatter to define page metadata in Mintlify?▼

Yes, you can use YAML frontmatter in your MDX files to define page metadata and structure. Mintlify reads this frontmatter to automatically configure page layouts and generate navigation for your documentation.

Does Mintlify support OpenAPI references for API documentation?▼

Mintlify supports integrating OpenAPI and API references alongside standard MDX pages. This allows you to combine structured API documentation with rich product docs and deploy them at scale.

How do I configure docs.json for a Mintlify documentation site?▼

You configure a Mintlify documentation site by placing a docs.json file at your project root. This file acts as the central site configuration, defining the structure and deployment settings for your MDX content.

When should I use Mintlify components in MDX documentation?▼

Use Mintlify components in your MDX documentation when you need consistent, rich formatting across developer portals or product docs. They provide reusable elements that maintain visual and functional consistency throughout your site.