mintlify

Automate Mintlify documentation site creation and maintenance with MDX and docs.json.

Updated Mar 5, 2026

Search Tags:#documentation #components #cli #navigation #mdx #docs.json #mintlify

Ready to run

npx skills add https://github.com/WellDunDun/docs --skill mintlify-welldundun

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/WellDunDun/docs/tree/main/.agents/skills/mintlify
Command: npx skills add https://github.com/WellDunDun/docs --skill mintlify-welldundun

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify is a platform that streamlines the creation and maintenance of documentation sites, reducing manual toil and keeping content consistent across pages.

Core Features & Use Cases

Create documented pages with MDX frontmatter and consistent navigation
Configure site-wide settings (docs.json) and reuse Mintlify components
Generate API reference pages from OpenAPI specs or manual endpoints
Collaborate on docs with teams and maintain versioned content

Quick Start

Install the Mintlify CLI and initialize your docs project, then run the local preview to verify changes.

Frequently Asked Questions about mintlify

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

FAQPage Schema

How do I build documentation sites using Mintlify and MDX?▼

You can build documentation sites by creating pages with MDX frontmatter and configuring the navigation using the Mintlify docs.json file. This automates site creation and ensures consistent navigation across all documentation pages.

How do I generate API reference pages from OpenAPI specs in Mintlify?▼

You can generate API reference pages in Mintlify by importing OpenAPI specifications or manually defining endpoints. This automates the creation of API documentation within your Mintlify-powered workstream.

Do I need Node.js to run the Mintlify CLI for local documentation previews?▼

Yes, you need Node.js installed to use the Mintlify CLI. Once installed, you can initialize your docs project and run the local preview to verify changes before publishing.

What is the best way to configure site-wide settings and navigation for Mintlify docs?▼

The best way to configure site-wide settings and navigation is by editing the docs.json file. This central configuration allows you to manage page hierarchy and reuse Mintlify components across your documentation.

Can I use Mintlify to collaborate with my team and maintain versioned content?▼

Yes, Mintlify supports team collaboration and maintaining versioned content. This streamlines the creation and maintenance of documentation sites while keeping content consistent across pages.

Why use MDX frontmatter when creating documentation pages with Mintlify?▼

MDX frontmatter is required to define page metadata and structure when creating documentation pages. It integrates with the docs.json configuration to render and publish consistent documentation sites.