Developer Setup & API Usage

Installation & Configuration

Mintlify docs are driven by a mint.json config file at the root of your docs repository. Define navigation, theming, and integrations there:

{
  "name": "My Product",
  "logo": { "light": "/logo/light.svg", "dark": "/logo/dark.svg" },
  "navigation": [
    { "group": "Getting Started", "pages": ["introduction", "quickstart"] },
    { "group": "API Reference", "pages": ["api-reference/overview"] }
  ],
  "colors": { "primary": "#0D9373" }
}

Key Features for Developers

GitHub-native publishing: Push Markdown/MDX to your repo → Mintlify auto-deploys on every commit.
API access: Programmatic endpoints for search, content retrieval, and feedback collection — enabling agents and tools to query your knowledge base directly.
LLM-optimized output: Pages are structured for agent consumption with semantic markup, making them ideal as RAG (Retrieval-Augmented Generation) sources.
1-click export to Cursor/Claude: Expose your full docs as a context source for developer AI tools with a single toggle.
OpenAPI / Swagger integration: Auto-generate interactive API reference pages from your OpenAPI spec.
Custom domains & SSO: Enterprise plans support custom domains, access controls, and SSO for internal knowledge bases.