Generated banner for Mintlify
Generated logo for Mintlify

Mintlify

ClineOfficialPublished by Cline

  • Skill
  • Tool integration
  • Documents and content
  • Apache-2.0
  • Low risk

From the author

Comprehensive reference for building Mintlify documentation sites. Use when creating pages, configuring docs.json, adding components, setting up navigation, or working with API references. Routes to detailed reference files for all components and configuration options.
— the description by Cline

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured reference for developing documentation sites with Mintlify. It covers the essential workflow for creating pages, configuring site settings via docs.json, managing navigation, and implementing API documentation. It includes guidelines for file organization, frontmatter usage, and writing standards, alongside a complete reference for CLI commands and MDX components.

What it does

  • Provides guidance on configuring site settings, themes, and navigation structures.
  • Details the use of MDX components like callouts, tabs, cards, and code groups.
  • Outlines standards for page frontmatter, internal linking, and image accessibility.
  • Lists CLI commands for local development, site validation, and content quality checks.
  • Explains how to integrate API documentation using OpenAPI specifications.
  • Offers instructions for accessing site analytics and managing authentication.

When to use it

  • When initializing a new Mintlify documentation project.
  • When adding new pages or restructuring existing site navigation.
  • When implementing or updating API reference documentation.
  • When troubleshooting site configuration or build errors.
  • When performing quality assurance checks like link validation or accessibility audits.

Advantages

  • Centralizes configuration and component syntax for consistent documentation.
  • Provides clear standards for maintaining documentation quality and structure.
  • Facilitates efficient site management through integrated CLI command references.
  • Ensures proper integration of interactive API playgrounds and documentation.

Usage examples

“How do I add a new page to my Mintlify site?”
The agent explains creating an MDX file, adding the required frontmatter, and updating the docs.json navigation file to ensure the page appears in the sidebar.
“Show me how to use a tabbed code block.”
The agent provides the correct Tabs and Tab component syntax to display multiple code snippets in a single block.
“How can I check my documentation for broken links?”
The agent provides the mint broken-links command and explains the available flags for checking anchors and external URLs.
“What are the required fields for page frontmatter?”
The agent lists the required title field and optional fields like description, icon, and hidden status for SEO and navigation control.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/cline/mintlify/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip mintlify.zip -d .agents/skills

Documentation by Cline

Mintlify reference

Reference for building documentation with Mintlify. This file covers essentials that apply to every task. For detailed reference on specific topics, read the files listed in the reference index below.

Reference index

Read these files only when your task requires them. They are in the reference/ directory next to this file.

FileWhen to read
reference/components.mdAdding or modifying components (callouts, cards, steps, tabs, accordions, code groups, fields, frames, icons, tooltips, badges, trees, mermaid, panels, prompts, colors, tiles, updates, views).
reference/configuration.mdChanging docs.json settings (theme, colors, logo, fonts, appearance, navbar, footer, banner, redirects, SEO, integrations, API config). Also covers snippets, hidden pages, .mintignore, custom CSS/JS, and the complete frontmatter fields table.
reference/navigation.mdModifying site navigation structure (groups, tabs, anchors, dropdowns, products, versions, languages, OpenAPI in nav).
reference/api-docs.mdSetting up API documentation (OpenAPI, AsyncAPI, MDX manual API pages, extensions, playground config).

Before you start

Read the project's docs.json file first. It defines the site's navigation, theme, colors, and configuration.

Search for existing content before creating new pages. You may need to update an existing page, add a section, or link to existing content rather than duplicating.

Read 2-3 similar pages to match the site's voice, structure, and formatting.

File format

Mintlify uses MDX files (.mdx or .md) with YAML frontmatter.

project/
├── docs.json           # Site configuration (required)
├── index.mdx
├── quickstart.mdx
├── guides/
│   └── example.mdx
├── openapi.yml         # API specification (optional)
├── images/             # Static assets
│   └── example.png
└── snippets/           # Reusable components
    └── component.jsx
File naming
  • Match existing patterns in the directory

  • If no existing files or mixed file naming patterns, use kebab-case: getting-started.mdx

  • Add new pages to docs.json navigation or they won't appear in the sidebar

  • Use root-relative paths without file extensions: /getting-started/quickstart

  • Do not use relative paths (../) or absolute URLs for internal pages

Images

Store images in an images/ directory. Reference with root-relative paths. All images require descriptive alt text.

![Dashboard showing analytics overview](/images/dashboard.png)

Page frontmatter

Every page requires title in its frontmatter. Include description and keywords for SEO.

---
title: "Clear, descriptive title"
description: "Concise summary for SEO and navigation."
keywords: ["relevant", "search", "terms"]
---
Common frontmatter fields
FieldTypeRequiredDescription
titlestringYesPage title in navigation and browser tabs.
descriptionstringNoBrief description for SEO. Displays under the title.
sidebarTitlestringNoShort title for sidebar navigation.
iconstringNoLucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path.
tagstringNoLabel next to page title in sidebar (e.g., "NEW").
hiddenbooleanNoRemove from sidebar. Page still accessible by URL.
modestringNoPage layout: default, wide, custom, frame, center.
keywordsarrayNoSearch terms for internal search and SEO.
apistringNoAPI endpoint for interactive playground (e.g., "POST /users").
openapistringNoOpenAPI endpoint reference (e.g., "GET /endpoint").

Quick component reference

Below are the most commonly used components. For full props and all 24 components, read reference/components.md.

Callouts
<Note>Supplementary information, safe to skip.</Note>
<Info>Helpful context such as permissions or prerequisites.</Info>
<Tip>Recommendations or best practices.</Tip>
<Warning>Potentially destructive actions or important caveats.</Warning>
<Check>Success confirmation or completed status.</Check>
<Danger>Critical warnings about data loss or breaking changes.</Danger>
Steps
<Steps>
  <Step title="First step">
    Instructions for step one.
  </Step>
  <Step title="Second step">
    Instructions for step two.
  </Step>
</Steps>
Tabs and code groups
<Tabs>
  <Tab title="npm">
    ```bash
    npm install package-name
    ```
  </Tab>
  <Tab title="yarn">
    ```bash
    yarn add package-name
    ```
  </Tab>
</Tabs>
<CodeGroup>

```javascript example.js
const greeting = "Hello, world!";
greeting = "Hello, world!"

</CodeGroup> ```

Cards and columns
<Columns cols={2}>
  <Card title="First card" icon="rocket" href="/quickstart">
    Card description text.
  </Card>
  <Card title="Second card" icon="book" href="/guides">
    Card description text.
  </Card>
</Columns>

Use <Columns> to arrange cards (or other content) in a grid. cols accepts 1-4.

Accordions
<AccordionGroup>
  <Accordion title="First section">Content one.</Accordion>
  <Accordion title="Second section">Content two.</Accordion>
</AccordionGroup>

CLI commands

Install the CLI with npm i -g mint.

Local development
  • mint dev — Start local preview at localhost:3000. --no-open skips browser launch. --groups <names> mocks user groups.

  • mint validate — Strict build validation; exits non-zero on warnings or errors.

  • mint export — Export a static site zip for air-gapped deployment. --output <file> sets the output path (default: export.zip).

Content quality
  • mint broken-links — Check for broken internal links. --check-anchors validates # anchors. --check-external checks external URLs. --check-snippets checks links inside <Snippet> components.

  • mint a11y — Accessibility checks (alt text, color contrast). --skip-contrast or --skip-alt-text to narrow scope.

Analytics
  • mint analytics stats — KPI numbers (views, visitors, searches). Options: --subdomain, --from, --to, --format (table/plain/json/graph), --agents/--humans to filter traffic, --page to filter to one path.

  • mint analytics search — Search analytics. --query filters by search term substring.

  • mint analytics feedback — Feedback analytics. --type (code or page).

  • mint analytics conversation list — List assistant conversations.

  • mint analytics conversation view <id> — View a single conversation.

  • mint analytics conversation buckets list — List conversation category buckets.

  • mint analytics conversation buckets view <id> — View conversations in a bucket.

Authentication
  • mint login — Authenticate your Mintlify account.

  • mint logout — Log out of your account.

  • mint status — Show current authentication status.

Configuration
  • mint config set <key> <value> — Persist a config value. Valid keys: subdomain, dateFrom, dateTo.

  • mint config get <key> — Read a stored config value.

  • mint config clear <key> — Remove a stored config value.

Project setup
  • mint new [directory] — Scaffold a new Mintlify docs site. --theme and --name set initial config.

  • mint workflow — Add a workflow to the docs repository.

Maintenance
  • mint update — Update the CLI to the latest version.

  • mint version — Show installed CLI and client versions.

Writing standards

  • Second-person voice ("you").

  • Active voice, direct language.

  • Sentence case for headings ("Getting started", not "Getting Started").

  • Sentence case for code block titles.

  • All code blocks must have language tags.

  • All images must have descriptive alt text.

  • No marketing language, filler phrases, or emoji.

  • Keep code examples simple, practical, and tested.

Common mistakes

  • Missing language tag on a code block (use ```python, not ```).

  • Using relative paths (../page) instead of root-relative (/section/page).

  • Forgetting to add new pages to docs.json navigation.

  • Images without alt text.

  • Adding file extensions to internal links (/page.mdx instead of /page).

Files

LICENSE

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to the Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by the Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding any notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   Copyright 2026 Cline Bot Inc.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Python, Needs Node.js

Security

What our scanner noticed· Low risk

  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Cline
Publisher
Cline (Official)
Source
cline/skills · skills/mintlify · commit 2637846
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Cline.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download mintlify.zip