/*
 * Adding Inter Variable from Adobe Fonts
 * © 2009-2025 Adobe Systems Incorporated. All Rights Reserved.
 */

@import url('https://p.typekit.net/p.css?s=1&k=zmy3zmk&ht=tk&f=55314&a=164646275&app=typekit&e=css');

@font-face {
  font-family: 'inter-variable';
  src: url('https://use.typekit.net/af/250efc/00000000000000007750957d/31/l?primer=7cdcb44be4a7db8877ffa5c0007b8dd865b3bbc383831fe2ea177f62257a9191&fvd=n4&v=3')
      format('woff2'),
    url('https://use.typekit.net/af/250efc/00000000000000007750957d/31/d?primer=7cdcb44be4a7db8877ffa5c0007b8dd865b3bbc383831fe2ea177f62257a9191&fvd=n4&v=3')
      format('woff'),
    url('https://use.typekit.net/af/250efc/00000000000000007750957d/31/a?primer=7cdcb44be4a7db8877ffa5c0007b8dd865b3bbc383831fe2ea177f62257a9191&fvd=n4&v=3')
      format('opentype');
  font-display: auto;
  font-style: normal;
  font-weight: 100 900;
  font-stretch: normal;
}

body {
  font-family: 'inter-variable', sans-serif;
}

Ask our docs

Watch video tutorials

Message support

Email support

We're here to help you get the most out of Mintlify

Contact support

Mintlify

Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers.

Introduction

Quickstart

Install the CLI to preview and develop your docs locally

Installation

Build your documentation using the Mintlify web editor

Web editor

Configure site-wide settings with the `docs.json` file

Global settings

Pages are the building blocks of your documentation

Pages

Structure and customize your documentation's navigation hierarchy

Navigation

Customize the appearance of your documentation

Themes

Host your documentation at your website's custom domain

Custom domain

Prepare your documentation for LLMs and AI tools

AI ingestion

Text, title, and styling in standard markdown

Headers and text

Add image, video, and other HTML elements

Images and embeds

Lists and tables

Code

Reusable, custom snippets to keep content in sync

Reusable snippets

A dropdown component to toggle content visibility

Accordions

Use callouts to add eye-catching context to your content

Callouts

Highlight main points or links with customizable icons

Cards

Columns

The CodeGroup component lets you combine code blocks in a display separated by tabs

Code groups

Display code blocks at the top-right of the page on desktop devices

Examples

Expandables

Set parameters for your API or SDK references

Fields

Use the Frame component to wrap images or other components in a container.

Frames

Icons

Mermaid

Specify the content of the right side panel

Panel

Sequence content using the Steps component

Steps

Tabs

Show a definition when you hover over text

Tooltips

Update

Playground

Reference OpenAPI endpoints in your docs pages

OpenAPI setup

Troubleshooting

Control who sees your documentation and customize their experience

Overview

Guarantee privacy of your docs by authenticating users

Authentication setup

Partial authentication setup

Let users log in for customized documentation experiences

Personalization setup

User data format for personalizing your documentation

Sending data

How to migrate documentation from your existing provider

Migrations

Help users succeed with your product and find answers faster

AI assistant

Generate MCP servers from your documentation or OpenAPI specs

Model Context Protocol

Configure Cursor to be your writing assistant

Cursor

Automatically translate your documentation with AI

Translations

Build interactive and reusable elements with React components

React

Fully customize your documentation with custom CSS and JS

Custom scripts

Hidden pages

Redirects and broken links

Deploy your docs from a repo that contains multiple projects

Monorepo setup

Deployments

GitHub

GitLab

Add checks for broken links, linting, and grammar to the updating process

CI checks

Preview changes to your docs in a live deployment

Preview deployments

Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check

Trigger Update

Get the status of an update from the status ID

Get Update Status

Creates a topic to manage message history for a given AI assistant conversation

Create Assistant Chat Topic

Generate a completion in response to a user query

Create Assistant Chat Message

Product updates

Start building modern documentation in under five minutes

Preview changes locally to update your docs

Local Development

Edit your docs directly from the dashboard with live previews.

Web Editor

Configure your documentation using the `docs.json` file

Global Settings

Organize your docs directory to guide your users to the information they need 

Migration

Setting the title and metadata for navigation and SEO

Page Titles and Metadata

Headers and Text

Images, Videos, and Embeds

Lists and Tables

Code Blocks

Reusable Snippets

Interactive Playground

OpenAPI Setup

Use OpenAPI features to enhance your Mintlify docs

Writing OpenAPI

Advanced Features

Generate docs pages for your API endpoints using MDX

MDX Setup

You can set authentication parameters to let users use their real API keys.

Authentication

Custom Domain

Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in mint.json or change them per page.

Redirects and Broken Links

Versioning & Localization

Allow more members of your team to update your docs

Editor Permissions

Preview Deployments

Fully customize your documentation with custom CSS

Custom CSS

Custom JS

Host documentation at a /docs subpath using Cloudflare Workers

Cloudflare

Host documentation at a /docs subdirectory using AWS services

AWS Route 53 and Cloudfront

Host documentation at a /docs subpath using Vercel

Vercel

Authenticate users to view only certain pages

Partial Authentication

A list of features unlocked with Personalization

Personalization

How to determine which product is best for you

Auth vs Personalization

The shape of user data you can use to personalize your docs

Sending Data

Integrate the Mintlify widget into your products to offer users quick access to AI-powered chat with your docs content as the knowledge base.

Getting started

Core configuration

Components

API pages

Authentication and personalization

Guides

Integrations

Version control and CI/CD

Contact support

Ask our docs

Watch video tutorials

Message support

Email support

Getting started

Core configuration

Components

API pages

Authentication and personalization

Guides

Integrations

Version control and CI/CD

​Ask our docs

​Watch video tutorials

​Message support

​Email support

Ask our docs

Watch video tutorials

Message support

Email support