Quickstart

Start building modern documentation in under five minutes

Getting Started

Welcome! Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify.

Creating the Repository

Mintlify docs are rendered from MDX files and configurations defined in our starter kit. We use GitHub to integrate your docs with your code, and make source control effortless. Onboard through the dashboard or clone our starter kit to get started.

Install the GitHub app

Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the dashboard, on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.

Monorepo Setup

If you want your docs to live alongside your code as a monorepo setup, you can: 1. Move your docs content to your monorepo. 2. Specify the path to your docs.json in the dashboard

Updating the Content

Mintlify enables you to easily customize the style, structure, and content of your docs.

Editing locally (recommended for developers)

1. Install git.
2. Once git is installed, clone your docs repository using git clone <your-repo>. If you haven’t set it up yet, now would be a good time to do so with these SSH keys.
3. Use your favorite IDE to open the repository.
4. Install our Mintlify CLI to preview changes with npm i -g mintlify.

Learn more about this in our local development guide.

Editing with the web editor

Learn more about how to use the web editor on our guide.

Customizing to your brand

Easily customize colors, logos and buttons among other configurations in our docs.json file. Start with these basic configurations:

"name": "Your Company"
"logo": {
  "light": "/logo/light.svg",
  "dark": "/logo/dark.svg",
  "href": "https://yourcompany.com"
},
"favicon": "/favicon.svg",
"colors": {
  "primary": "#2AB673",
  "light": "#55D799",
  "dark": "#117866",
},

A full list of supported configurations can be found at global settings.

Adding content

Add content with simple MDX files. Initiate your pages with this template:

---
title: "Page Title"
sidebarTitle: "Sidebar title (optional - if different from page title)"
description: "Subtitle (optional)"
---

Learn more about adding images, tables, lists, and more using the MDX syntax. We also offer a wide array of components.

Pushing changes

Once ready, commit and push your changes to update your docs site. Here is a guide on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our dashboard.

Generating API references

You can easily set up your API references using an OpenAPI document.

1. Add your openapi.yaml or openapi.json file into your docs repository or define the openapi field in docs.json with a URL.

"openapi": "link-to-your-openapi-file"

2. Use our scraper to autogenerate your OpenAPI endpoints files as:

npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>

3. Finally, include the generated endpoint MDX files to your docs.json under navigation.

For a complete guide on using Mintlify with OpenAPI, check out this guide. This guide explains how to configure your API authentication methods. For manual API references definition, explore our syntax.

Adding analytics

Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your dashboard.

We also support integrations with a range of analytics providers. You can find the list of providers here.

We provide a white-glove migration service as part of our Enterprise plan. Interested? You can request it by contacting us.

Publishing

Adding a custom domain

Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.

Navigate to your dashboard settings to add a custom domain.

Congrats, you’ve set up your documentation on Mintlify!

Need support or want to give some feedback? You can click support in the dashboard (bottom left corner) or reach out to [e-mail].

You can also join our community to engage with other Mintlify users and stay up to date with the latest feature drops.