mintlify

Build and deploy documentation sites with Mintlify, MDX, and OpenAPI.

1|Updated Mar 9, 2026

Search Tags:#documentation #deployment #api docs #mdx #developer portal #mintlify

Ready to run

npx skills add https://github.com/docaohieu2808/claude-skills --skill mintlify-docaohieu2808

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill streamlines the creation and deployment of modern documentation websites, transforming Markdown/MDX into interactive sites with advanced features.

Core Features & Use Cases

Project Scaffolding: Quickly initialize new documentation projects.
Content Creation: Utilize MDX components for rich content (Steps, Cards, CodeGroups).
API Documentation: Integrate OpenAPI/AsyncAPI specs for interactive API docs.
AI Features: Configure AI assistant, LLM optimization, and agent-ready skill.md generation.
Deployment: Automate builds and deployments to various platforms.
Use Case: You need to create a developer portal for your new API. This Skill helps you scaffold the project, write API reference pages using OpenAPI specs, add conceptual guides with MDX components, and deploy it to a custom domain.

Quick Start

Run mint new to scaffold a new documentation project.

Frequently Asked Questions about mintlify

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

FAQPage Schema

How do I build and deploy a developer portal using MDX?▼

To build and deploy a developer portal using MDX, you can scaffold a project with the Mintlify CLI and utilize MDX components to create interactive pages. This process integrates OpenAPI specifications and automates deployment through CI/CD pipelines.

Can I generate interactive API documentation from OpenAPI specs?▼

Yes, you can generate interactive API documentation by integrating OpenAPI or AsyncAPI specifications. The framework automatically transforms these specs into reference pages, allowing developers to explore endpoints directly within the deployed portal.

Do I need npm installed to create a documentation site with Mintlify?▼

Yes, npm and the Mintlify CLI are required dependencies for project initialization, local development, and deployment. You must have the Node.js environment configured to run the necessary CLI commands for scaffolding and building.

What is the best way to automate documentation deployment to a custom domain?▼

The best way to automate documentation deployment is by integrating the build process with CI/CD pipelines. This approach automatically builds the MDX content and API specs, deploying the generated static assets to your custom domain upon updates.

Does this approach support adding an AI assistant for developer documentation?▼

Yes, the framework supports configuring an AI assistant and optimizing content for LLMs. You can generate agent-ready `skill.md` files to provide AI features directly within your developer documentation portal.