What is Mintlify Docs and How to Use It: A Beginner’s Guide

Discover Mintlify, the AI-native docs platform! This beginner’s guide covers installation, custom domains, AI ingestion, MCP servers, translations, and OpenAPI for stunning, user-friendly documentation.

Ashley Goolam

Ashley Goolam

4 June 2025

What is Mintlify Docs and How to Use It: A Beginner’s Guide

Are you struggling to create sleek, user-friendly documentation that doesn’t feel like a chore? Say hello to Mintlify, the AI-native platform that makes building stunning docs as easy as writing a blog post. With 28K+ GitHub stars and clients like Stripe, Mintlify offers interactive features, AI tools, and seamless integrations to level up your docs game. In this beginner’s guide, I’ll walk you through installing Mintlify, setting up a custom domain, leveraging AI ingestion, integrating an MCP server, adding translations, and using OpenAPI for API docs. Whether you’re a developer or a team lead, you’ll be shipping pro-level docs in no time. Ready to make documentation fun? Let’s dive in!

💡
Before we get started, if you're looking to streamline your API development, Apidog offers an all-in-one platform for designing, testing, and documenting APIs. With its intuitive interface and robust features, it's perfect for both beginners and seasoned developers. Best of all, you can get started for free! (apidog)
button

What is Mintlify? Your Docs Superpower

Mintlify is a modern documentation platform that helps developers create beautiful, interactive, and SEO-friendly docs with minimal fuss. Built for teams and open-source projects, it renders Markdown and MDX files into responsive pages, supports GitHub integration, and packs AI-driven features like code generation and translations. Key perks include:

With a drag-and-drop workflow and 40% higher user conversion rates, Mintlify is perfect for startups or public projects. Let’s set it up

mintlify.com

Installing and Setting Up Mintlify

Getting started with Mintlify is a breeze, and you’ll need Node.js, the Mintlify CLI, and a GitHub account. Here’s how to kick things off, based on the official guide.

1. Install Prerequisites:

2. Clone the Starter Kit:

git clone https://github.com/mintlify/starter-kit
cd starter-kit

3. Install Mintlify CLI:

npm install -g mintlify-cli

4. Run the Local Preview:

mintlify-cli dev

5. Edit Your Docs:

{
  "name": "My Docs",
  "theme": "prism",
  "colors": { "primary": "#3498db" }
}

I set this up in under 10 minutes and had a live site with my tweaks—super smooth!

Setting Up a Custom Domain for Mintlify

Want your docs to live at docs.yourcompany.com instead of a mintlify.app subdomain? Mintlify makes custom domains easy.

1. Access Settings:

custom domain

2. Add Your Domain:

cname

3. Wait for Propagation:

I set up a custom domain for a test site, and it was live in a few hours—professional vibes all the way!

Leveraging AI Ingestion with Mintlify

Mintlify’s AI ingestion makes your docs smarter and more accessible, letting users search content via AI-powered queries.

1. Enable AI Ingestion:

ai chat

2. Test AI Search:

3. Enhance with AI Fixes:

I tried the AI search on a sample site, and it found my API docs instantly—way faster than manual browsing!

Integrating an MCP Server with Mintlify

The Model Context Protocol (MCP) lets AI apps interact with your docs or APIs. Mintlify generates an MCP server to bridge your content with LLMs.

1. Install the MCP CLI:

npm i @mintlify/mcp

2. Configure the MCP Server:

3. Use the MCP Server:

Installing Mintlify MCP Server Locally

To run the Mintlify MCP server on your machine:  

npx @mintlify/mcp add mintlify
install mintlify locally

Example: I used Windsurf, and the terminal gave me:

node C:\User\Me.mcp\mintlify\src\index.js
mcp command

Sample Prompt (in Windsurf):    

Write a help doc about this feature based on this PRD, in the style and tone of AppleDB docs.

Or, for Mintlify-compatible format:  

Write this in markdown using Mintlify components like anchors.
run in mcp client

I set up an MCP server, and it let my AI assistant query my docs like a pro—futuristic stuff!

Adding Translations to Mintlify Docs

Want your docs in multiple languages? Mintlify’s AI-powered translations make localization a snap.

1. Enable Translations:

mintlify translation

2. Customize Translations:

3. Test the Translation:

switch between languages

I added Spanish translations, and my docs were global-ready in minutes—huge win for accessibility!

view all languages

Using Mintlify with VS Code

Documenting code in VS Code? Mintlify’s extension makes it a snap!

1. Install the Mintlify Extension:

vs code mintlify extension

2. Generate Documentation:

Sample Code:

test("@e2e wait for api response", async ({ page }) => {
  const sidemenuPage = new SideMenuPage(page);
  await sidemenuPage.interceptApiLink.click();
  const response = await page.waitForResponse((response) =>
    response.url().includes("/comments")
  );
  expect(response.status()).toBe(200);
  await page.getByText("CREATE post").isVisible();
});

Generated Documentation:

The code block is a test case that checks if the API response is received successfully.
use mintlify in vs code

I documented a test script, and Mintlify nailed the description—effortless!

Exploring Mintlify’s Features

Mintlify is packed with tools to make your docs shine. Here’s how to level up:

I tweaked my theme and added tabs, making my docs look like a pro design in under an hour!

Wrapping Up: Your Mintlify Journey Begins

Great job—you’ve unlocked the power of Mintlify to create stunning, AI-ready documentation! From installing the CLI to setting up custom domains, AI ingestion, MCP servers, translations, and OpenAPI playgrounds, you’re ready to build docs that wow users. Experiment with new components, add more languages, or document your APIs with APIdog! Happy documenting!

button

Explore more

How to Get 500 More Cursor Premium Requests with Interactive Feedback MCP Server

How to Get 500 More Cursor Premium Requests with Interactive Feedback MCP Server

If you're a Cursor Premium user, you've probably felt the frustration of hitting the 500 fast request limit faster than expected. One moment you're in a productive coding flow, and the next, you're staring at the dreaded "You've hit your limit of 500 fast requests" message. What if I told you there's a way to effectively double your request efficiency and make those 500 requests feel like 1000? 💡Want a great API Testing tool that generates beautiful API Documentation? Want an integrated, All-

5 June 2025

Is ChatGPT Pro Worth $200 Per Month?

Is ChatGPT Pro Worth $200 Per Month?

If you've been using ChatGPT regularly and find yourself repeatedly hitting usage limits or wishing for more advanced capabilities, you may have encountered mentions of ChatGPT Pro—OpenAI's premium subscription tier priced at 200 per month. This significant price jump from the more widely known ChatGPT Plus (20/month) raises an important question: Is ChatGPT Pro actually worth ten times the cost of Plus? The answer depends largely on your specific use cases, professional needs, and how you valu

5 June 2025

10 Fintech APIs and Solutions for Developers in 2025

10 Fintech APIs and Solutions for Developers in 2025

The financial technology landscape is undergoing a rapid transformation as innovative APIs (Application Programming Interfaces) revolutionize how we build banking services, payment systems, investment platforms, and other financial applications. For developers working in this space, selecting the right fintech API is critical—it can make the difference between a seamless user experience and a frustrating one, between robust security and potential vulnerabilities. As fintech applications become

5 June 2025

Practice API Design-first in Apidog

Discover an easier way to build and use APIs