Props

Mintlify

Components

Integrations

Advanced

Get Started

Community

Card Groups

Start building modern documentation in under five minutes

Quickstart

Preview changes locally to update your docs

Development

Customize your documentation using the mint.json file

Global Settings

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

Navigation

Setting the title and metadata for navigation and SEO

Page Titles and Metadata

Text, title, and styling in standard markdown

Headers and Text

Add image, video, and other HTML elements

Images, Videos, and Embeds

Lists and Tables

Code Blocks

Reusable, custom snippets to keep content in sync

Reusable Snippets

Interactive Playground

Reference OpenAPI endpoints in your docs pages

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

Troubleshooting

Host the documentation at your website's custom subdomain

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.

Search Engine Optimization

Redirects and Broken Links

Versioning

Allow more members of your team to update your docs

Editor Permissions

GitHub

GitLab

Customize how your team can login to Mintlify

Single Sign-On (SSO)

Integrate with an analytics platform to track viewer events

Analytics Integrations

Amplitude

Clearbit

Fathom

Google Analytics 4

Google Tag Manager

Heap

HotJar

Koala

Logrocket

Mixpanel

Pirsch

Plausible

PostHog

Automate your SDK usage snippets in the API playground

Speakeasy

Automate your SDK example snippets in the API playground

Stainless

Support Integrations

Intercom

Front

Privacy Integrations

Osano

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

Route 53 and Cloudfront

Chat Widget

Introduction

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

Trigger an update

Get the status of an update

Give your users a personalized docs experience

How to decide which auth method is right for your docs

Choosing an Auth Method

Seamlessly share user sessions between your dashboard and your docs

Shared Session Auth

Use a customized login flow to authenticate users

JWT Auth

The types and shape of user data you can send to Mintlify

Sending Data

A dropdown component for toggling content

Accordions

Group multiple accordions into a single display.

Accordion Groups

Use callouts to add eye-catching context to your content

Callout Boxes

Highlight main points or links with customizable icons

Cards

Display code with optional syntax highlighting

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

Components

API Components

Card Groups

First Card

Second Card

Third Card

Fourth Card

Props

Components

API Components

First Card

Second Card

Third Card

Fourth Card

​Props

Props