mintlify

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

Updated Feb 16, 2026
One-click install
npx skills add https://github.com/travis-burmaster/agentbox --skill mintlify-travis-burmaster
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/travis-burmaster/agentbox/tree/main/agentfork/.agents/skills/mintlify
Command: npx skills add https://github.com/travis-burmaster/agentbox --skill mintlify-travis-burmaster

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires mint.

What problem does it solve? Writing and maintaining documentation sites requires knowing Mintlify's specific conventions for MDX pages, navigation structure, components, and the docs.json configuration file, which is easy to get wrong without guidance. ## Core Features & Use Cases - Docs Site Authoring: Create MDX documentation pages with correct frontmatter, components, and internal linking conventions. - Navigation & Configuration: Structure site navigation in docs.json using groups, tabs, anchors, dropdowns, products, versions, and languages. - API Documentation: Generate endpoint pages from OpenAPI specs or write manual API reference pages with ParamField and ResponseField components. - Use Case: You need to add a new quickstart guide to your docs site. The Skill reads your docs.json, matches the existing writing style, creates the MDX page, adds it to navigation, and validates the build with the Mintlify CLI. ## Quick Start Use the mintlify skill to create a new getting-started page in my docs directory and add it to the navigation in docs.json.

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 with Mintlify?

Create a docs.json file for site configuration and write content in MDX files with YAML frontmatter containing at least a title. Install the CLI with npm i -g mint, then run mint dev to preview locally at localhost:3000.

How do I add API reference pages in Mintlify?

Add your OpenAPI spec to docs.json with the openapi property and endpoint pages auto-generate. Without a spec, write manual pages using api frontmatter like "POST /users" with ParamField and ResponseField components.

Should I use mint.json or docs.json for Mintlify configuration?

Always use docs.json. The mint.json file is deprecated and should never be used. The docs.json file controls navigation, theme, colors, links, redirects, and API specifications.

Why is my new Mintlify page not showing in the sidebar?

Pages only appear in the sidebar when added to the navigation property in docs.json. Pages not listed in navigation are hidden pages, accessible by URL but not discoverable through sidebar navigation.

How do I check Mintlify docs for broken links and errors?

Run mint broken-links to check internal links and mint validate to find build errors. You can also run mint a11y to check content for accessibility issues before deploying.