mintlify

Create and maintain Mintlify documentation sites with MDX and docs.json.

1|1|Updated Nov 11, 2025
One-click install
npx skills add https://github.com/in-co-sandbox/in-co-sandbox-docs --skill mintlify-in-co-sandbox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mintlify
Source: https://github.com/in-co-sandbox/in-co-sandbox-docs/tree/main/ai/skills/mintlify
Command: npx skills add https://github.com/in-co-sandbox/in-co-sandbox-docs --skill mintlify-in-co-sandbox

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps users build and maintain documentation sites using Mintlify, streamlining the process of creating content, configuring site structure, and deploying documentation.

Core Features & Use Cases

  • Documentation Site Creation: Guides users on setting up and configuring documentation sites with Mintlify.
  • Content Organization: Provides best practices for structuring content using docs.json, including navigation patterns.
  • API Documentation: Assists in documenting APIs, either through OpenAPI specifications or manual endpoint definitions.
  • Customization & Deployment: Offers guidance on customizing site appearance and deploying changes.
  • Use Case: A developer needs to create a new documentation site for their API. They can use this Skill to understand how to structure their MDX files, configure the navigation in docs.json, and deploy the site using the Mintlify CLI.

Quick Start

Use the mintlify skill to validate the documentation build for the current project.

Frequently Asked Questions about mintlify

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

FAQPage Schema
How do I build a documentation site using Mintlify and MDX files?

To build a documentation site with Mintlify, you structure content using MDX files and configure site navigation and settings via the docs.json file. This approach streamlines content creation and site deployment using Git-based workflows.

How do I generate API reference documentation from OpenAPI specs?

You can generate API reference documentation by providing OpenAPI specifications to the Mintlify platform. The Skill assists in documenting APIs either through these specs or via manual endpoint definitions within your MDX content.

What is the best way to configure navigation for a Mintlify documentation site?

The best way to configure navigation is by defining your site structure and routing patterns inside the docs.json configuration file. This file manages content organization and navigation patterns for the documentation.

Do I need Node.js to deploy a Mintlify documentation site?

Node.js is required to run Mintlify CLI operations for deploying your documentation site. The platform supports Git-based workflows, allowing you to validate builds and deploy changes directly from your local environment.

Can I customize the appearance of my Mintlify documentation site?

Yes, you can customize the appearance of your Mintlify documentation site. The Skill provides guidance on customizing site visuals and deploying those changes alongside your MDX content and configuration updates.