ck:mintlify

Build and deploy Mintlify documentation sites from Markdown and MDX sources.

Updated Apr 2, 2026
One-click install
npx skills add https://github.com/hidonguyen/trade-ops --skill ck-mintlify-hidonguyen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ck:mintlify
Source: https://github.com/hidonguyen/trade-ops/tree/main/.opencode/skills/mintlify
Command: npx skills add https://github.com/hidonguyen/trade-ops --skill ck-mintlify-hidonguyen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Mintlify removes the friction of turning Markdown/MDX and OpenAPI specs into attractive, interactive documentation sites and developer portals, saving teams time on configuration, component wiring, and deployment plumbing.

Core Features & Use Cases

  • Docs scaffolding & configuration: Central docs.json controls theme, navigation, products, versions, and i18n so teams maintain consistent doc sites.
  • MDX components & API integration: Rich MDX components (cards, steps, code groups, mermaid, param/response fields) plus OpenAPI/AsyncAPI auto-generation and interactive playgrounds.
  • AI & agent readiness: Generates llms.txt and skill.md, exposes MCP, and integrates contextual AI search and bots for Slack/Discord.
  • Use Case: Engineering teams can auto-generate API reference pages from OpenAPI, enable AI-assisted search, validate with mint validate, and deploy previews via GitHub/GitLab/Vercel pipelines.

Quick Start

Create and deploy a Mintlify documentation site from this repository using docs.json and included OpenAPI specs, enable AI features (llms.txt and MCP), run mint validate, and publish a preview deployment.

Frequently Asked Questions about ck:mintlify

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

FAQPage Schema
How do I generate interactive API reference pages from OpenAPI specs?

Generating interactive API reference pages from OpenAPI specs involves extracting endpoints into pages using Mintlify, which auto-generates interactive playgrounds and param/response fields. This removes the friction of manually wiring components for developer portals.

What is the best way to configure navigation and theme for MDX documentation sites?

Configuring navigation and theme for MDX documentation sites requires a central docs.json file to control settings. This approach ensures teams maintain consistent doc sites across multiple products, versions, and i18n configurations without repetitive setup.

How do I enable AI-assisted search and agent readiness for developer portals?

Enabling AI-assisted search and agent readiness for developer portals involves generating llms.txt and skill.md files. Mintlify exposes MCP and integrates contextual AI search with bots for Slack/Discord to help users find information automatically.

Does Mintlify work with CI/CD pipelines for preview deployments?

Mintlify works with CI/CD pipelines to deploy preview environments via GitHub, GitLab, or Vercel. Teams can run mint validate to check configurations and automatically publish preview deployments during the pipeline process.

Can I use rich MDX components like mermaid diagrams and code groups in technical documentation?

You can use rich MDX components like mermaid diagrams, code groups, cards, and steps in technical documentation. Mintlify renders these interactive MDX components natively alongside auto-generated API content to create engaging knowledge bases.

When do I need llms.txt and MCP files for API documentation?

You need llms.txt and MCP files for API documentation when preparing sites for AI-assisted search and agent integrations. Generating these files ensures developer portals expose contextual search and bot capabilities for Slack and Discord environments.