mintlify

Convert MDX into structured Mintlify documentation sites within Git workflows.

202|36|Updated Jan 27, 2026

Search Tags:#documentation #mdx #static-site #docs.json #mintlify #documentation-best-practices

Ready to run

npx skills add https://github.com/adoresever/AGI_Ananas --skill mintlify-adoresever

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/adoresever/AGI_Ananas/tree/main/26.2.21openclaw-viking/.agents/skills/mintlify
Command: npx skills add https://github.com/adoresever/AGI_Ananas --skill mintlify-adoresever

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mintlify best practices help teams consistently transform MDX content into navigable, well-structured documentation sites, reducing ambiguity and rework.

Core Features & Use Cases

Centralizes guidance for configuring site-wide Mintlify settings, including the docs.json schema, frontmatter-driven pages, and built-in components.
Supports creating, organizing, and maintaining comprehensive documentation within a Git-based workflow, with reusable patterns.
Real-world use: set up a docs site that documents a software project, including API references and navigation tailored to teams.

Quick Start

Install Mintlify in your project and start the local development server to preview your documentation site.

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 and a Git-based workflow?▼

You can build a documentation site by authoring MDX content and converting it into structured pages using Mintlify. This approach centralizes navigation configuration and site maintenance directly within a Git-based workflow.

What is the best way to configure site-wide documentation settings in Mintlify?▼

The best way to configure site-wide documentation settings is through the docs.json schema. This file centralizes navigation, frontmatter-driven page settings, and built-in component configurations across your entire project.

How do I add an API reference and custom components to my MDX documentation?▼

You can add an API reference and custom components by utilizing optional assets and built-in components within your MDX files. This extends your documentation to support interactive API endpoints alongside standard pages.

Does Mintlify work within a Git-based workflow for team documentation?▼

Yes, Mintlify is designed specifically for a Git-based workflow, allowing teams to consistently create, organize, and maintain comprehensive documentation while reducing ambiguity and rework through reusable patterns.

When do I need frontmatter-driven pages for my static documentation site?▼

You need frontmatter-driven pages when you want to apply consistent metadata and structure across multiple MDX documents. This ensures standardized navigation and page configuration within your Mintlify site.

Why does my MDX documentation site need a docs.json configuration file?▼

Your MDX documentation site needs a docs.json configuration file to define site-wide settings and the navigation schema. It serves as the central source of truth for structuring and organizing your documentation pages.