mintlify

Create and deploy documentation sites from Markdown/MDX with docs.json configurations.

Updated Feb 27, 2026

Search Tags:#documentation #deployment #api #openapi #ai #mdx #mintlify

Ready to run

npx skills add https://github.com/haidonglethqb/CloudSchool --skill mintlify-haidonglethqb

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/haidonglethqb/CloudSchool/tree/main/.claude/skills/mintlify
Command: npx skills add https://github.com/haidonglethqb/CloudSchool --skill mintlify-haidonglethqb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Mintlify automates the creation and deployment of rich, navigable documentation from Markdown/MDX, enabling teams to publish consistent docs quickly.

Core Features & Use Cases

Auto-generates API documentation using OpenAPI/AsyncAPI frontmatter and code samples.
Provides navigation, theming, and 7+ built-in MDX components to create developer portals and knowledge bases.
Supports deployment to popular platforms (GitHub, Vercel, Cloudflare, AWS) and integration with docs.json configurations for multi-environment setups.

Quick Start

Run mint new to scaffold a docs project and mint dev to preview locally.

Frequently Asked Questions about mintlify

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

FAQPage Schema

How do I generate API documentation from an OpenAPI definition?▼

You can generate API documentation by using OpenAPI frontmatter within Markdown or MDX files. This approach automates the creation of interactive API references, including code samples, directly from your existing OpenAPI or AsyncAPI definitions.

What is the best way to build and deploy a developer portal using MDX?▼

Building a developer portal with MDX involves using a docs.json configuration to define navigation and theming. This process auto-generates a rich, navigable documentation site that can be quickly deployed across multiple environments.

Can I deploy MDX documentation sites to AWS or Cloudflare?▼

Yes, MDX documentation sites can be deployed to popular platforms including GitHub, Vercel, Cloudflare, and AWS. The deployment process integrates with your docs.json configurations to support multi-environment setups.

How do I scaffold a new documentation project and preview it locally?▼

To scaffold a new documentation project, run the 'mint new' command to generate the initial structure. You can then use 'mint dev' to preview the documentation site locally before deploying it to your target environment.

Does Mintlify support building knowledge bases with built-in navigation and theming?▼

Mintlify supports creating knowledge bases by providing customizable navigation structures, theming options, and over seven built-in MDX components. This enables rapid assembly of structured, navigable developer portals from Markdown content.

How does AI-assisted documentation work with Markdown and MDX files?▼

AI-assisted documentation features integrate directly with your Markdown and MDX content to automate site generation and enhance user search. This functionality streamlines the creation of rich, navigable documentation sites without manual formatting overhead.