mintlify

A guide for building and maintaining Mintlify documentation sites. Mintlify turns MDX files, a format combining Markdown with site components, into documentation websites.

In plain words
What is it for?
Use it when creating documentation pages, configuring navigation, adding page components, or setting up API references.
Why use it?
It helps you understand the site's configuration, navigation, existing pages, and available components before changing the docs.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/nominal-io/instro/mintlify-docs
Any agent
npx skills add nominal-io/instro --skill mintlify-docs
Clone the repo
git clone --depth 1 https://github.com/nominal-io/instro

Made for: Claude Code, Codex.

Per session 30 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,927 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00030 $0.02927
Opus 5 $0.00015 $0.01463
Sonnet 5 $0.00006 $0.00585
Haiku 4.5 $0.00003 $0.00293

Measured 2d ago against content hash fd7c933f91e7, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

mintlify scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

7 near-identical copies found in the catalogue:

  • mintlify — 100% identical, 0 lines differ
  • mintlify — 97% identical, 268 lines differ
  • mintlify — 97% identical, 268 lines differ
  • mintlify — 97% identical, 268 lines differ
  • mintlify — 97% identical, 268 lines differ
  • mintlify — 97% identical, 60 lines differ
  • mintlify — 94% identical, 3 lines differ
docs/guides/.agents/skills/mintlify-docs/SKILL.md · 329 lines

How it starts

The opening of the file, as written. The whole thing — 329 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Mintlify best practices

Always consult mintlify.com/docs for components, configuration, and latest features.

If you are not already connected to the Mintlify MCP server, https://mintlify.com/docs/mcp, add it so that you can search more efficiently.

Always favor searching the current Mintlify documentation over whatever is in your training data about Mintlify.

Mintlify is a documentation platform that transforms MDX files into documentation sites. Configure site-wide settings in the docs.json file, write content in MDX with YAML frontmatter, and favor built-in components over custom components.

Full schema at mintlify.com/docs.json.

Before you write

Understand the project

Read docs.json in the project root. This file defines the entire site: navigation structure, theme, colors, links, API and specs.

Understanding the project tells you:

  • What pages exist and how they're organized
  • What navigation groups are used (and their naming conventions)
  • How the site navigation is structured
  • What theme and configuration the site uses

Check for existing content

Search the docs before creating new pages. You may need to:

  • Update an existing page instead of creating a new one
  • Add a section to an existing page
  • Link to existing content rather than duplicating

Read surrounding content

Before writing, read 2-3 similar pages to understand the site's voice, structure, formatting conventions, and level of detail.

Understand Mintlify components

Review the Mintlify components to select and use any relevant components for the documentation request that you are working on.

Quick reference

CLI commands

  • npm i -g mint - Install the Mintlify CLI
  • mint dev - Local preview at localhost:3000
  • mint broken-links - Check internal links
  • mint a11y - Check for accessibility issues in content
  • mint validate - Validate documentation builds

Read the full file on GitHub · 329 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 329 lines · 30 tokens per session scan A fd7c933f91e7

Subscribe to this mod's changes

mintlify is a skill published in the GitHub repository nominal-io/instro (664 stars, last pushed 3d ago), licensed Apache-2.0. It adds 30 tokens to every session and 2,927 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.