mintlify

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

2|1|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/zester4/zilmate --skill mintlify-zester4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/zester4/zilmate/tree/main/.agents/skills/mintlify
Command: npx skills add https://github.com/zester4/zilmate --skill mintlify-zester4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining documentation sites requires knowing Mintlify's configuration schema, component library, and navigation patterns, which are easy to get wrong without guidance. ## Core Features & Use Cases - Docs Site Configuration: Set up and edit docs.json for navigation, themes, tabs, groups, redirects, and SEO settings. - MDX Content Authoring: Write documentation pages with correct frontmatter, components like Steps, Tabs, and Cards, and consistent writing standards. - 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 quickstart guide to your docs site. The Skill reads your docs.json, matches your existing page style, writes the MDX page, and registers it in navigation. ## Quick Start Ask the assistant to create a new getting-started page in your Mintlify docs and add it to the docs.json navigation.

Frequently Asked Questions about mintlify

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

FAQPage Schema
How do I create a new documentation page in Mintlify?

Create an MDX file with YAML frontmatter containing at least a title, then add the page path to the navigation section of docs.json. Pages not listed in docs.json remain hidden from the sidebar.

How do I configure navigation in Mintlify docs.json?

Use the navigation property in docs.json and choose a primary pattern such as groups, tabs, anchors, dropdowns, products, versions, or languages. Groups are the default for a single audience, while tabs suit distinct sections like guides versus API reference.

Can Mintlify generate API reference pages from OpenAPI?

Yes. Add your OpenAPI spec to docs.json with the openapi property, and Mintlify auto-generates endpoint pages. You can also write manual endpoint pages using the api frontmatter field for full control.

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

Always use docs.json. The mint.json file is deprecated, and all site configuration including navigation, theme, redirects, and SEO settings belongs in docs.json.

How do I check a Mintlify docs site for broken links?

Run mint broken-links with the Mintlify CLI to check internal links, and run mint validate to catch build errors. Install the CLI globally with npm i -g mint and preview locally using mint dev.