ck:mintlify

Automate creation and deployment of Mintlify documentation sites.

Updated Aug 27, 2026

Search Tags:#theming #documentation #openapi #navigation #mdx #api-docs #mintlify

Ready to run

npx skills add https://github.com/tonamson/please-done --skill ck-mintlify-tonamson

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ck:mintlify
Source: https://github.com/tonamson/please-done/tree/main/ck/.opencode/skills/mintlify
Command: npx skills add https://github.com/tonamson/please-done --skill ck-mintlify-tonamson

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Mintlify provides a streamlined approach to creating, organizing, and deploying documentation sites for APIs and products, reducing manual overhead and ensuring consistency across docs.

Core Features & Use Cases

OpenAPI/AsyncAPI integration for automated API docs generation
MDX components and navigation/theming to build rich docs with minimal code
Deployment and hosting options with CI/CD integrations
AI-assisted features and MCP for enhanced AI tooling
Supports multi-language and versioned docs
Use case example: a team modeling API docs from OpenAPI specs to speed up onboarding

Quick Start

Install Mintlify globally, scaffold a new docs project, and run a local development server to preview changes.

Frequently Asked Questions about ck:mintlify

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

FAQPage Schema

How do I generate API docs from an OpenAPI spec automatically?▼

To build API docs with Mintlify, install the CLI globally, scaffold a new docs project, and run a local development server. This setup previews changes to your MDX components, navigation, and theming configurations locally before deployment.

Do I need a docs.json configuration file to build documentation with Mintlify?▼

Yes, a Mintlify project requires a docs.json configuration file to function properly. You can also include optional references, scripts, and assets directories alongside it to extend navigation, theming, and documentation capabilities.

Can I use MDX components to customize navigation and theming in Mintlify?▼

Mintlify distinguishes itself by offering integrated AI-assisted features and Model Context Protocol (MCP) tooling directly within the documentation. This approach enhances developer onboarding by allowing AI tools to query and interact with your docs natively.

What is the best way to manage multi-language and versioned API documentation?▼

Mintlify natively supports multi-language and versioned documentation out of the box. You can configure different versions and languages within your docs.json file to ensure users access the correct API reference materials for their specific environment.

How does deploying documentation with Mintlify work with CI/CD pipelines?▼

Mintlify provides built-in deployment and hosting options that integrate seamlessly with existing CI/CD pipelines. This automates the publication of your MDX content and OpenAPI references, ensuring your hosted docs automatically reflect repository updates.