Quickstart

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.

Updating the Content

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

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.

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.

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

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"

Use our scraper to autogenerate your OpenAPI endpoints files as:

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

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.

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

Publishing

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 [email protected].

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

Getting Started

Writing Content

API References

Configurations

Advanced

Getting Started

Creating the Repository

Updating the Content

Publishing

Getting Started

Writing Content

API References

Configurations

Advanced

​Getting Started

​Creating the Repository

​Updating the Content

​Publishing

Getting Started

Creating the Repository

Updating the Content

Publishing