mintlify

Apply Mintlify best practices for frontmatter, Markdown, and navigation.

2|2|Updated Aug 4, 2025
One-click install
npx skills add https://github.com/WebMCP-org/docs --skill mintlify-webmcp-org
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/WebMCP-org/docs/tree/main
Command: npx skills add https://github.com/WebMCP-org/docs --skill mintlify-webmcp-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify best practices guide writers on creating consistent, well-structured documentation by enforcing frontmatter, component usage, and navigation patterns.

Core Features & Use Cases

  • Frontmatter discipline ensures every page includes title and description for SEO and indexing.
  • Component guidance directs when to use Mintlify components (Steps, CodeGroup, Card, etc.) for clarity and consistency.
  • Navigation discipline prescribes docs.json structure and root-relative links to ensure reliable discovery and linking.

Quick Start

Create a new Mintlify page with proper frontmatter and add it to docs.json.

Frequently Asked Questions about mintlify

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

FAQPage Schema
What frontmatter do I need for a Mintlify documentation page?▼

Mintlify frontmatter requires a title and description on every documentation page to ensure proper SEO and site indexing. Including these fields helps search engines discover and correctly rank your content.

How do I structure Markdown and navigation in Mintlify?▼

Structure Mintlify navigation by defining the docs.json file with root-relative links. This navigation discipline ensures reliable page discovery and consistent linking across your documentation site.

When should I use Mintlify components like Steps and CodeGroup?▼

Use Mintlify components like Steps, CodeGroup, and Card when you need to improve clarity and visual consistency on a page. Component guidance directs writers to apply these elements for structured content presentation.

What are the best practices for writing Mintlify documentation?▼

Mintlify documentation best practices enforce strict frontmatter discipline, structured Markdown conventions, proper code block formatting, and organized navigation patterns to maintain consistent authoring across the site.

How do I add a new page to my Mintlify site navigation?▼

To add a new Mintlify page, create a Markdown file with proper frontmatter and register it in the docs.json file using root-relative links. This ensures reliable discovery and indexing across the site.

Does Mintlify require specific code block conventions for documentation?▼

Yes, Mintlify best practices prescribe specific code block conventions within your Markdown structure. Following these formatting rules ensures consistent rendering and readability across all documentation pages.