Write and edit Mintlify documentation with Cursor

Use Cursor’s built-in AI features to draft, edit, and maintain your Mintlify documentation with full awareness of components and writing standards.

Cursor’s AI features become significantly more useful for documentation work once they understand Mintlify’s component library, frontmatter conventions, and writing standards. Installing the Mintlify skill gives Cursor that context, so Tab completions, Chat responses, and Cmd+K edits all follow the patterns your docs site expects.

Prerequisites

• Cursor installed on your machine
• A Mintlify docs repository with a docs.json file at the root

Setup

1. Open your docs directory in Cursor

   Open the folder that contains your docs.json file as the project root in Cursor. Cursor’s AI features use the open project for context, so opening the right directory matters.

2. Install the Mintlify skill

   In Cursor’s integrated terminal, run the following command from your docs root:

   npx skills add https://mintlify.com/docs
   

   This installs Mintlify’s component reference, writing standards, and workflow guidance into Cursor’s context. After installation, Cursor’s AI features will understand how to use <Steps>, <Card>, <Tabs>, and all other Mintlify components correctly.

3. Customize AGENTS.md

   Open the AGENTS.md file created in your docs root and add any project-specific instructions. This is where you define the rules that apply to your docs site specifically, such as product terminology, style preferences, and what content is in or out of scope.

   ## 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
   

   AGENTS.md is the right place to teach the AI about your product’s vocabulary, tone, and content boundaries. The more specific you are here, the less you’ll need to correct in generated drafts.

4. Start writing

   Use Cursor’s AI features to draft and edit documentation:

   • Tab — Accept inline completions as you type in .mdx files
   • Chat — Ask Cursor to draft a new page, restructure a section, or explain a component
   • Cmd+K — Select a block of text and prompt Cursor to rewrite or improve it

   Cursor will apply Mintlify component syntax, frontmatter conventions, and your AGENTS.md rules automatically.