skills.rest
Dozyboy
DozyboyCOMMUNITY
Explore all skills by this author →
GitHub

hs:mintlify

Build and maintain Mintlify documentation sites with docs.json, MDX components, and CLI validation.

Updated Jul 19, 2026
Search Tags:#documentation#openapi#static site#api reference#mdx#docs.json#mintlify
One-click install
npx skills add https://github.com/Dozyboy/VSF --skill hs-mintlify-dozyboy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: hs:mintlify
Source: https://github.com/Dozyboy/VSF/tree/main/Day2_VSF/Demo1/harness/plugins/hs/disabled-skills/mintlify
Command: npx skills add https://github.com/Dozyboy/VSF --skill hs-mintlify-dozyboy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires mintlify, and includes references (resource) components.

What problem does it solve? Setting up and maintaining a Mintlify documentation site requires knowing the docs.json schema, dozens of MDX components, navigation patterns, and CLI validation commands, which is difficult to memorize and easy to misconfigure. ## Core Features & Use Cases - Configuration Guidance: Covers the complete docs.json schema including themes, colors, branding, navigation, tabs, anchors, products, versions, and 28+ language locales. - MDX Component Reference: Documents all 26+ built-in components such as Tabs, Steps, Cards, ParamField, ResponseField, and Mermaid diagrams for structured content. - API Documentation: Auto-generates API reference pages from OpenAPI and AsyncAPI specs with interactive playgrounds and multi-language code examples. - Deployment & AI Features: Covers Git-based auto-deploy, preview deployments, custom domains, subpath hosting, llms.txt, skill.md, MCP, and Discord/Slack bots. - Use Case: A developer needs to migrate an existing docs site to Mintlify, configure versioned navigation, validate the setup with mint validate and mint broken-links, and deploy via GitHub integration. ## Quick Start Ask the assistant to scaffold a new Mintlify docs project and configure docs.json with a theme, navigation groups, and an OpenAPI spec for your API reference.

Frequently Asked Questions about hs:mintlify

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

FAQPage Schema
How do I set up a Mintlify documentation site?▼

Install the CLI with npm i -g mintlify, run mint new to scaffold a project, then configure docs.json with a theme, name, colors, and navigation. Use mint dev to preview locally on port 3000.

How do I generate API documentation from OpenAPI in Mintlify?▼

Point the api.openapi field in docs.json to your OpenAPI spec file, then add openapi frontmatter like "GET /users/{id}" to MDX pages. Mintlify auto-generates parameters, examples, and response schemas.

What MDX components does Mintlify support?▼

Mintlify provides 26+ components including Tabs, CodeGroup, Steps, Cards, Accordions, callouts (Note, Warning, Tip), ParamField, ResponseField, RequestExample, and Mermaid diagrams for structured documentation content.

Does Mintlify support multiple versions and languages?▼

Yes, docs.json supports versions, products, and 28+ language locales. Each navigation group can be scoped to a specific version, product, or language with independent page trees.

How do I validate Mintlify docs before deployment?▼

Run mint validate to check docs.json, mint broken-links to verify links, mint a11y for accessibility, and mint openapi-check for API specs. These commands can be integrated into GitHub Actions or GitLab CI pipelines.

Can Mintlify docs be hosted on a custom domain or subpath?▼

Yes, configure DNS records pointing to mintlify-dns.com for custom domains, or use a reverse proxy (Nginx, Apache, Cloudflare Workers) with the basePath setting in docs.json for subpath hosting like example.com/docs.

Related Skills

Explore More Software Engineering Skills→
pluginagentmarketplacepluginagentmarketplace
3

api-documentation

Generate OpenAPI, AsyncAPI, or Protobuf specifications and Markdown or HTML documentation.

Community
Advanced
NicolaeRotaruNicolaeRotaru

analytics

Designs and implements analytics tracking plans with GA4, GTM, and UTM conventions.

Community
Intermediate
hashicorphashicorp
78

content-freshness

Analyze Markdown documentation for outdated versions, broken links, and deprecated patterns.

Official
Basic
Logos-LiberLogos-Liber
17

documentation-tools

Compare static site generators and documentation platforms for technical documentation workflows.

Official
Intermediate