Skip to main content
Claude Code is Anthropic’s AI coding agent that runs in your terminal and operates directly on your files. Installing the Mintlify skill teaches Claude Code how to use Mintlify’s component library, frontmatter conventions, and writing standards, so it can draft and edit documentation pages without needing constant correction.

​
Prerequisites

  • An active Claude subscription (Pro, Max, or API access)
  • A Mintlify docs repository with a docs.json file at the root
  • Node.js installed on your machine

​
Setup

1

Install Claude Code

Install the Claude Code CLI globally using npm:
npm install -g @anthropic-ai/claude-code
2

Install the Mintlify skill

Navigate to your docs root (the directory containing docs.json) and run:
npx skills add https://mintlify.com/docs
This installs Mintlify’s component reference, writing standards, and workflow guidance into Claude Code’s context. Claude Code will use this to correctly apply <Steps>, <Card>, <Tabs>, and all other Mintlify components when generating or editing pages.
3

Customize AGENTS.md

Open the AGENTS.md file in your docs root and add project-specific instructions. Claude Code reads this file automatically at the start of every session.
## Terminology
- Use "workspace" not "project"
- Use "deployment" not "publish"

## Style
- Keep code examples under 20 lines
- Always include a description callout before API reference tables
Everything you add to AGENTS.md becomes a standing instruction for Claude Code. Use it to capture your product’s vocabulary, preferred writing style, and what’s in or out of scope for documentation — so you don’t have to repeat those rules in every prompt.
4

Launch Claude Code

From your docs root, start a Claude Code session:
claude
You can now ask Claude Code to draft new pages, update existing content, fix frontmatter, or restructure sections. It will apply Mintlify component syntax and your AGENTS.md rules throughout the session.