From 4c1e9523628953fd3412c28c42b62068d4200840 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 04:52:07 +0000
Subject: [PATCH 01/14] Update quickstart.mdx
---
quickstart.mdx | 257 ++++++++++++++++++++++---------------------------
1 file changed, 113 insertions(+), 144 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 076b50534..de48df9f0 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -1,251 +1,220 @@
---
title: "Quickstart"
-description: "Deploy your documentation in minutes"
+description: "Get your documentation site live in under 10 minutes"
icon: "rocket"
---
-This quickstart guide shows you how to set up and deploy your documentation site in minutes.
-
-After completing this guide, you will have a live documentation site ready to customize and expand.
+Build and deploy beautiful documentation in minutes. This guide walks you through creating your first documentation site from setup to deployment.
-
-**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.
-
+**Before you start**: You'll need a [Mintlify account](https://mintlify.com/start). The onboarding process creates your first project automatically.
-## Getting started
+## Your site is already live
-After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format:
+Once you complete onboarding, your documentation site is automatically deployed at:
```
https://.mintlify.app
```
-Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/).
+You can find this URL on your [dashboard overview](https://dashboard.mintlify.com/).
-Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site.
-
-### Install the GitHub App
+## Connect your GitHub repository
-Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
+Link your GitHub repository to enable automatic deployments when you push changes.
-Install the GitHub App by following the instructions from the onboarding checklist or your dashboard.
+### Install the GitHub App
-1. Navigate to **Settings** in your Mintlify dashboard.
-2. Select **GitHub App** from the sidebar.
-3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page.
-4. Select the organization or user account where you want to install the app.
-5. Select the repositories that you want to connect.
+1. Go to **Settings** → **GitHub App** in your dashboard
+2. Click **Install GitHub App**
+3. Select your organization and repositories
+4. Complete the installation
-
- Update the GitHub App permissions if you move your documentation to a different repository.
-
-
-### Authorize your GitHub account
-
-1. Navigate to **Settings** in your Mintlify dashboard.
-2. Select **My Profile** from the sidebar.
-3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.
+### Authorize your account
-
- An admin for your GitHub organization may need to authorize your account depending on your organization settings.
-
+1. Navigate to **Settings** → **My Profile**
+2. Click **Authorize GitHub account**
+3. Complete the authorization process
-## Editing workflows
+
+Organization admins may need to approve the authorization depending on your GitHub settings.
+
-Mintlify offers two workflows for creating and maintaining your documentation:
+## Choose your editing workflow
-
- For users who prefer working with existing tools in their local environment. Click to jump to this section.
-
+Pick the workflow that matches your team's preferences:
-
- For users who prefer a visual interface in their web browser. Click to jump to this section.
-
+
+
+ Edit files locally with your favorite tools and Git workflow
+
+
+ Visual editing directly in your browser with instant previews
+
+
-## Code-based workflow
+## Local development
-The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.
+Perfect for developers who want to integrate documentation into their existing workflow.
### Install the CLI
-To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:
+Install the Mintlify CLI to work with your documentation locally:
- ```bash npm
- npm i -g mint
- ```
+```bash npm
+npm i -g mint
+```
- ```bash pnpm
- pnpm add -g mint
- ```
+```bash pnpm
+pnpm add -g mint
+```
-
- You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide.
-
+
+Requires Node.js v19 or higher. Check your version with `node --version`.
+
-### Edit the documentation
+### Make your first edit
-After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
+Let's update your homepage title:
-1. Open your repository created during onboarding.
-2. Open `index.mdx` and locate the top of the file:
+1. Open your documentation repository
+2. Edit `index.mdx` and change the title:
```mdx index.mdx
---
-title: "Introduction"
+title: "Welcome to our docs" // [!code ++]
+title: "Introduction" // [!code --]
description: "This is the introduction to the documentation"
---
```
-3. Update the `title` field to `"Hello World"`.
+### Preview locally
-```mdx index.mdx {2}
----
-title: "Hello World"
-description: "This is the introduction to the documentation"
----
-```
-
-### Preview the changes
-
-To preview the changes locally, run the following command:
+Start the development server to see your changes:
```bash
mint dev
```
-Your preview will be available at `localhost:3000`.
+Your site will be available at `http://localhost:3000`.
- 
- 
+
+
-### Push the changes
-
-When you are ready to publish your changes, push them to your repository.
+### Deploy your changes
-Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).
+Push your changes to GitHub. Mintlify automatically builds and deploys your updates.
-After the deployment completes, your latest update will be available at `.mintlify.app`.
-
-
- Optionally, skip the web editor workflow and jump to adding a custom domain.
-
+```bash
+git add .
+git commit -m "Update homepage title"
+git push origin main
+```
-## Web editor workflow
+Monitor deployment status in your GitHub repository or dashboard.
-The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.
+## Web editor
-### Access the web editor
+Ideal for content creators who prefer visual editing without technical setup.
-1. Log in to your [dashboard](https://dashboard.mintlify.com).
-2. Select **Editor** on the left sidebar.
+### Access the editor
-
- If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
-
+1. Open your [dashboard](https://dashboard.mintlify.com)
+2. Click **Editor** in the sidebar
- 
- 
+
+
-### Edit the documentation
+### Edit your content
-In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:
-
-Find and select `index.mdx` in the file explorer.
-
-Then, in the editor, update the title field to "Hello World".
+1. Select `index.mdx` from the file explorer
+2. Update the title field to "Welcome to our docs"
+3. Use the rich formatting tools or type `/` for the command menu
- 
- 
+
+
-
- The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools.
-
-
-### Publish your changes
+### Publish instantly
-When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site.
+Click **Publish** in the top-right corner. Your changes go live immediately.
- Use branches to preview and review changes through pull requests before deploying to your live site.
+Use branches to preview changes before publishing to your main site. Learn more in our [web editor guide](/editor/getting-started).
-For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor/getting-started).
+## Add a custom domain
-## Adding a custom domain
+Replace your `.mintlify.app` subdomain with your own domain for a professional look.
-While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
-
-To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
+1. Go to **Settings** → **Domain Setup** in your dashboard
+2. Enter your domain (e.g., `docs.yourcompany.com`)
+3. Add the CNAME record to your DNS provider:
- 
- 
+
+
-Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider.
-
-
| Record Type | Name | Value | TTL |
|-------------|------|-------|-----|
-| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
-
+| CNAME | docs | cname.mintlify.app | 3600 |
- DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
+DNS changes typically take 5-30 minutes but can take up to 48 hours to fully propagate.
-## Next steps
+## What's next?
-Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:
+Your documentation site is live! Here are the most impactful next steps:
-
- Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
-
-
- Learn how to customize colors, fonts, and the overall appearance of your documentation site.
-
-
- Structure your documentation with intuitive navigation to help users find what they need.
-
-
- Enhance your documentation with interactive components like accordions, tabs, and code samples.
-
-
- Create interactive API references with OpenAPI and AsyncAPI specifications.
-
+
+
+ Match your brand colors and styling
+
+
+ Structure your content for easy discovery
+
+
+ Enhance pages with interactive elements
+
+
+ Generate interactive API references
+
+
-## Troubleshooting
-
-If you encounter issues during the setup process, check these common troubleshooting solutions:
+## Need help?
-
- Make sure you have Node.js v19+ installed and that you run the `mint dev` command from the directory containing your `docs.json` file.
+
+ Ensure you have Node.js v19+ and run `mint dev` from your project root directory (where `docs.json` is located).
-
- Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
+
+
+ Check your GitHub Actions tab for build errors. Deployments typically take 1-3 minutes.
-
- Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record.
+
+
+ Verify your CNAME record is correct and wait for DNS propagation. Use [DNSChecker](https://dnschecker.org) to verify your setup.
+
+Still stuck? [Contact our support team](contact-support) for personalized help.
\ No newline at end of file
From defc35849ca974a5b00f656fb77aa27bb730f4bd Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 04:59:55 +0000
Subject: [PATCH 02/14] Delete quickstart.mdx
---
quickstart.mdx | 220 -------------------------------------------------
1 file changed, 220 deletions(-)
delete mode 100644 quickstart.mdx
diff --git a/quickstart.mdx b/quickstart.mdx
deleted file mode 100644
index de48df9f0..000000000
--- a/quickstart.mdx
+++ /dev/null
@@ -1,220 +0,0 @@
----
-title: "Quickstart"
-description: "Get your documentation site live in under 10 minutes"
-icon: "rocket"
----
-
-Build and deploy beautiful documentation in minutes. This guide walks you through creating your first documentation site from setup to deployment.
-
-
-**Before you start**: You'll need a [Mintlify account](https://mintlify.com/start). The onboarding process creates your first project automatically.
-
-
-## Your site is already live
-
-Once you complete onboarding, your documentation site is automatically deployed at:
-
-```
-https://.mintlify.app
-```
-
-You can find this URL on your [dashboard overview](https://dashboard.mintlify.com/).
-
-
-
-
-
-
-## Connect your GitHub repository
-
-Link your GitHub repository to enable automatic deployments when you push changes.
-
-### Install the GitHub App
-
-1. Go to **Settings** → **GitHub App** in your dashboard
-2. Click **Install GitHub App**
-3. Select your organization and repositories
-4. Complete the installation
-
-
-
-
-
-
-### Authorize your account
-
-1. Navigate to **Settings** → **My Profile**
-2. Click **Authorize GitHub account**
-3. Complete the authorization process
-
-
-Organization admins may need to approve the authorization depending on your GitHub settings.
-
-
-## Choose your editing workflow
-
-Pick the workflow that matches your team's preferences:
-
-
-
- Edit files locally with your favorite tools and Git workflow
-
-
- Visual editing directly in your browser with instant previews
-
-
-
-## Local development
-
-Perfect for developers who want to integrate documentation into their existing workflow.
-
-### Install the CLI
-
-Install the Mintlify CLI to work with your documentation locally:
-
-
-```bash npm
-npm i -g mint
-```
-
-```bash pnpm
-pnpm add -g mint
-```
-
-
-
-Requires Node.js v19 or higher. Check your version with `node --version`.
-
-
-### Make your first edit
-
-Let's update your homepage title:
-
-1. Open your documentation repository
-2. Edit `index.mdx` and change the title:
-
-```mdx index.mdx
----
-title: "Welcome to our docs" // [!code ++]
-title: "Introduction" // [!code --]
-description: "This is the introduction to the documentation"
----
-```
-
-### Preview locally
-
-Start the development server to see your changes:
-
-```bash
-mint dev
-```
-
-Your site will be available at `http://localhost:3000`.
-
-
-
-
-
-
-### Deploy your changes
-
-Push your changes to GitHub. Mintlify automatically builds and deploys your updates.
-
-```bash
-git add .
-git commit -m "Update homepage title"
-git push origin main
-```
-
-Monitor deployment status in your GitHub repository or dashboard.
-
-## Web editor
-
-Ideal for content creators who prefer visual editing without technical setup.
-
-### Access the editor
-
-1. Open your [dashboard](https://dashboard.mintlify.com)
-2. Click **Editor** in the sidebar
-
-
-
-
-
-
-### Edit your content
-
-1. Select `index.mdx` from the file explorer
-2. Update the title field to "Welcome to our docs"
-3. Use the rich formatting tools or type `/` for the command menu
-
-
-
-
-
-
-### Publish instantly
-
-Click **Publish** in the top-right corner. Your changes go live immediately.
-
-
-Use branches to preview changes before publishing to your main site. Learn more in our [web editor guide](/editor/getting-started).
-
-
-## Add a custom domain
-
-Replace your `.mintlify.app` subdomain with your own domain for a professional look.
-
-1. Go to **Settings** → **Domain Setup** in your dashboard
-2. Enter your domain (e.g., `docs.yourcompany.com`)
-3. Add the CNAME record to your DNS provider:
-
-
-
-
-
-
-| Record Type | Name | Value | TTL |
-|-------------|------|-------|-----|
-| CNAME | docs | cname.mintlify.app | 3600 |
-
-
-DNS changes typically take 5-30 minutes but can take up to 48 hours to fully propagate.
-
-
-## What's next?
-
-Your documentation site is live! Here are the most impactful next steps:
-
-
-
- Match your brand colors and styling
-
-
- Structure your content for easy discovery
-
-
- Enhance pages with interactive elements
-
-
- Generate interactive API references
-
-
-
-## Need help?
-
-
-
- Ensure you have Node.js v19+ and run `mint dev` from your project root directory (where `docs.json` is located).
-
-
-
- Check your GitHub Actions tab for build errors. Deployments typically take 1-3 minutes.
-
-
-
- Verify your CNAME record is correct and wait for DNS propagation. Use [DNSChecker](https://dnschecker.org) to verify your setup.
-
-
-
-Still stuck? [Contact our support team](contact-support) for personalized help.
\ No newline at end of file
From 6e2407fae6a8972816f9ed7159adbf5fc487e3a0 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:00:37 +0000
Subject: [PATCH 03/14] Update docs.json
---
docs.json | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs.json b/docs.json
index e364b4726..4ec2a7b61 100644
--- a/docs.json
+++ b/docs.json
@@ -20,7 +20,6 @@
"group": "Getting started",
"pages": [
"index",
- "quickstart",
"installation",
{
"group": "Web editor",
From b3f2d1069cdeb1f2445cc6ce3d461b326469662f Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:07:47 +0000
Subject: [PATCH 04/14] Update quickstart.mdx
---
quickstart.mdx | 126 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 126 insertions(+)
create mode 100644 quickstart.mdx
diff --git a/quickstart.mdx b/quickstart.mdx
new file mode 100644
index 000000000..9d8f59e4e
--- /dev/null
+++ b/quickstart.mdx
@@ -0,0 +1,126 @@
+---
+title: Quickstart
+description: Get up and running with Mintlify in minutes
+---
+
+Get your documentation site up and running in under 5 minutes.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/) (version 18 or higher)
+- A GitHub account
+- Basic familiarity with Markdown
+
+## Installation
+
+
+
+ Install the Mintlify CLI globally using npm:
+
+ ```bash
+ npm i -g mintlify
+ ```
+
+
+
+ Create a new documentation project:
+
+ ```bash
+ mintlify init
+ ```
+
+ This creates a `mint.json` configuration file and sample documentation files.
+
+
+
+ Preview your documentation locally:
+
+ ```bash
+ mintlify dev
+ ```
+
+ Your documentation will be available at `http://localhost:3000`.
+
+
+
+## Create your first page
+
+1. Open the generated `introduction.mdx` file
+2. Replace the content with your own:
+
+```mdx
+---
+title: Welcome to my docs
+description: This is my awesome documentation
+---
+
+# Welcome
+
+This is my first documentation page built with Mintlify.
+
+## Getting started
+
+Add your content here using Markdown and MDX components.
+```
+
+3. Save the file and see your changes instantly in the browser
+
+## Configure your site
+
+Edit `mint.json` to customize your documentation:
+
+```json mint.json
+{
+ "name": "My Documentation",
+ "logo": {
+ "dark": "/logo/dark.svg",
+ "light": "/logo/light.svg"
+ },
+ "favicon": "/favicon.svg",
+ "colors": {
+ "primary": "#0D9373",
+ "light": "#07C983",
+ "dark": "#0D9373"
+ },
+ "navigation": [
+ {
+ "group": "Get Started",
+ "pages": ["introduction"]
+ }
+ ]
+}
+```
+
+## Deploy your site
+
+
+
+ Connect your repository and deploy automatically
+
+
+ Set up your own domain name
+
+
+
+## Next steps
+
+
+
+ Enhance your docs with interactive components
+
+
+ Track how users interact with your documentation
+
+
+ Organize your content with custom navigation
+
+
+ Make your documentation match your brand
+
+
+
+## Need help?
+
+
+ Get help from our support team
+
\ No newline at end of file
From 1c9f74ffd1bce4f9e1dd67e2ad6ddd930d2cd9bf Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:07:58 +0000
Subject: [PATCH 05/14] Update docs.json
---
docs.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs.json b/docs.json
index 4ec2a7b61..e364b4726 100644
--- a/docs.json
+++ b/docs.json
@@ -20,6 +20,7 @@
"group": "Getting started",
"pages": [
"index",
+ "quickstart",
"installation",
{
"group": "Web editor",
From e1414349b539f65eef150e21083574e285377c50 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:08:07 +0000
Subject: [PATCH 06/14] Update quickstart.mdx
---
quickstart.mdx | 214 +++++++++++++++++++++++++++++--------------------
1 file changed, 128 insertions(+), 86 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 9d8f59e4e..9da4f67e7 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -1,126 +1,168 @@
---
-title: Quickstart
-description: Get up and running with Mintlify in minutes
+title: "Quickstart"
+description: "Get your documentation site up and running in minutes with Mintlify"
+icon: "rocket"
---
-Get your documentation site up and running in under 5 minutes.
+Get your documentation site live in under 5 minutes. This guide walks you through creating, customizing, and deploying your first Mintlify docs site.
## Prerequisites
-- [Node.js](https://nodejs.org/en/) (version 18 or higher)
- A GitHub account
- Basic familiarity with Markdown
-## Installation
+## Step 1: Create your docs repository
-
- Install the Mintlify CLI globally using npm:
-
+
+ Visit the [Mintlify starter template](https://github.com/mintlify/starter) and click **Use this template** to create a new repository.
+
+
+
```bash
- npm i -g mintlify
+ git clone https://github.com/your-username/your-docs-repo.git
+ cd your-docs-repo
```
+
-
- Create a new documentation project:
-
+## Step 2: Install and preview locally
+
+
+
```bash
- mintlify init
+ npm i -g mintlify
```
-
- This creates a `mint.json` configuration file and sample documentation files.
-
-
- Preview your documentation locally:
-
+
+
```bash
mintlify dev
```
-
- Your documentation will be available at `http://localhost:3000`.
+ Your docs will be available at `http://localhost:3000`
-## Create your first page
-
-1. Open the generated `introduction.mdx` file
-2. Replace the content with your own:
-
-```mdx
----
-title: Welcome to my docs
-description: This is my awesome documentation
----
-
-# Welcome
-
-This is my first documentation page built with Mintlify.
-
-## Getting started
-
-Add your content here using Markdown and MDX components.
-```
-
-3. Save the file and see your changes instantly in the browser
-
-## Configure your site
+## Step 3: Customize your site
-Edit `mint.json` to customize your documentation:
-
-```json mint.json
-{
- "name": "My Documentation",
- "logo": {
- "dark": "/logo/dark.svg",
- "light": "/logo/light.svg"
- },
- "favicon": "/favicon.svg",
- "colors": {
- "primary": "#0D9373",
- "light": "#07C983",
- "dark": "#0D9373"
- },
- "navigation": [
+
+
+ Edit the `mint.json` file to configure your site:
+
+ ```json mint.json
+ {
+ "name": "Your Docs",
+ "logo": {
+ "dark": "/logo/dark.svg",
+ "light": "/logo/light.svg"
+ },
+ "favicon": "/favicon.svg",
+ "colors": {
+ "primary": "#0D9373",
+ "light": "#07C983",
+ "dark": "#0D9373"
+ }
+ }
+ ```
+
+
+
+ Create a new `.mdx` file in your repository:
+
+ ```markdown introduction.mdx
+ ---
+ title: 'My First Page'
+ description: 'This is my first documentation page'
+ ---
+
+ # Welcome to my docs
+
+ This is the beginning of something great!
+ ```
+
+
+
+ Add your new page to the navigation in `mint.json`:
+
+ ```json mint.json
{
- "group": "Get Started",
- "pages": ["introduction"]
+ "navigation": [
+ {
+ "group": "Get Started",
+ "pages": ["introduction"]
+ }
+ ]
}
- ]
-}
-```
+ ```
+
+
-## Deploy your site
+## Step 4: Deploy your site
+
+
+
+ 1. Go to [mintlify.com](https://mintlify.com) and sign in with GitHub
+ 2. Click **Create new docs** and select your repository
+ 3. Your site will automatically deploy
+
+
+
+ Your docs are now live at `https://your-repo-name.mintlify.app`
+
+
-
- Connect your repository and deploy automatically
+
+ Configure colors, fonts, and branding to match your style
+
+
+
+ Enhance your docs with interactive components and rich content
+
+
+
+ Track how users interact with your documentation
+
- Set up your own domain name
+ Use your own domain for a professional look
+## Troubleshooting
+
+
+
+ If you encounter permission errors, try:
+ ```bash
+ sudo npm i -g mintlify
+ ```
+
+ Or use a Node version manager like [nvm](https://github.com/nvm-sh/nvm).
+
+
+
+ Make sure you're in the correct directory and have a valid `mint.json` file. Try:
+ ```bash
+ mintlify install
+ mintlify dev
+ ```
+
+
+
+ Check that:
+ - Your repository is public or you've granted Mintlify access
+ - Your `mint.json` file is valid JSON
+ - All referenced pages exist in your repository
+
+
+
## Next steps
-
-
- Enhance your docs with interactive components
-
-
- Track how users interact with your documentation
-
-
- Organize your content with custom navigation
-
-
- Make your documentation match your brand
+
+
+ Understand how to structure and organize your documentation
-## Need help?
-
-
- Get help from our support team
-
\ No newline at end of file
+Your documentation site is now live! Continue customizing and adding content to create the perfect docs experience for your users.
\ No newline at end of file
From 82178bd6562a681c4638bd1e3e9125c6eb939717 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:09:52 +0000
Subject: [PATCH 07/14] Delete quickstart.mdx
---
quickstart.mdx | 168 -------------------------------------------------
1 file changed, 168 deletions(-)
delete mode 100644 quickstart.mdx
diff --git a/quickstart.mdx b/quickstart.mdx
deleted file mode 100644
index 9da4f67e7..000000000
--- a/quickstart.mdx
+++ /dev/null
@@ -1,168 +0,0 @@
----
-title: "Quickstart"
-description: "Get your documentation site up and running in minutes with Mintlify"
-icon: "rocket"
----
-
-Get your documentation site live in under 5 minutes. This guide walks you through creating, customizing, and deploying your first Mintlify docs site.
-
-## Prerequisites
-
-- A GitHub account
-- Basic familiarity with Markdown
-
-## Step 1: Create your docs repository
-
-
-
- Visit the [Mintlify starter template](https://github.com/mintlify/starter) and click **Use this template** to create a new repository.
-
-
-
- ```bash
- git clone https://github.com/your-username/your-docs-repo.git
- cd your-docs-repo
- ```
-
-
-
-## Step 2: Install and preview locally
-
-
-
- ```bash
- npm i -g mintlify
- ```
-
-
-
- ```bash
- mintlify dev
- ```
- Your docs will be available at `http://localhost:3000`
-
-
-
-## Step 3: Customize your site
-
-
-
- Edit the `mint.json` file to configure your site:
-
- ```json mint.json
- {
- "name": "Your Docs",
- "logo": {
- "dark": "/logo/dark.svg",
- "light": "/logo/light.svg"
- },
- "favicon": "/favicon.svg",
- "colors": {
- "primary": "#0D9373",
- "light": "#07C983",
- "dark": "#0D9373"
- }
- }
- ```
-
-
-
- Create a new `.mdx` file in your repository:
-
- ```markdown introduction.mdx
- ---
- title: 'My First Page'
- description: 'This is my first documentation page'
- ---
-
- # Welcome to my docs
-
- This is the beginning of something great!
- ```
-
-
-
- Add your new page to the navigation in `mint.json`:
-
- ```json mint.json
- {
- "navigation": [
- {
- "group": "Get Started",
- "pages": ["introduction"]
- }
- ]
- }
- ```
-
-
-
-## Step 4: Deploy your site
-
-
-
- 1. Go to [mintlify.com](https://mintlify.com) and sign in with GitHub
- 2. Click **Create new docs** and select your repository
- 3. Your site will automatically deploy
-
-
-
- Your docs are now live at `https://your-repo-name.mintlify.app`
-
-
-
-
-
- Configure colors, fonts, and branding to match your style
-
-
-
- Enhance your docs with interactive components and rich content
-
-
-
- Track how users interact with your documentation
-
-
-
- Use your own domain for a professional look
-
-
-
-## Troubleshooting
-
-
-
- If you encounter permission errors, try:
- ```bash
- sudo npm i -g mintlify
- ```
-
- Or use a Node version manager like [nvm](https://github.com/nvm-sh/nvm).
-
-
-
- Make sure you're in the correct directory and have a valid `mint.json` file. Try:
- ```bash
- mintlify install
- mintlify dev
- ```
-
-
-
- Check that:
- - Your repository is public or you've granted Mintlify access
- - Your `mint.json` file is valid JSON
- - All referenced pages exist in your repository
-
-
-
-## Next steps
-
-
-
- Understand how to structure and organize your documentation
-
-
-
-Your documentation site is now live! Continue customizing and adding content to create the perfect docs experience for your users.
\ No newline at end of file
From 244ddc038d5f8594c25d0ef18ea16934354d127a Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:10:05 +0000
Subject: [PATCH 08/14] Update docs.json
---
docs.json | 1 -
1 file changed, 1 deletion(-)
diff --git a/docs.json b/docs.json
index e364b4726..4ec2a7b61 100644
--- a/docs.json
+++ b/docs.json
@@ -20,7 +20,6 @@
"group": "Getting started",
"pages": [
"index",
- "quickstart",
"installation",
{
"group": "Web editor",
From 886e2c361b460022333be23f53692e9af6d733a0 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:11:11 +0000
Subject: [PATCH 09/14] Update quickstart.mdx
---
quickstart.mdx | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 94 insertions(+)
create mode 100644 quickstart.mdx
diff --git a/quickstart.mdx b/quickstart.mdx
new file mode 100644
index 000000000..0d6b0edd7
--- /dev/null
+++ b/quickstart.mdx
@@ -0,0 +1,94 @@
+---
+title: Quickstart
+description: Get started with Mintlify in minutes
+---
+
+## Welcome to Mintlify
+
+Get your documentation site up and running in just a few minutes with this quickstart guide.
+
+## Prerequisites
+
+Before you begin, make sure you have:
+- A GitHub account
+- Basic familiarity with Markdown
+- Your documentation content ready
+
+## Step 1: Create your documentation
+
+
+
+ Start by creating a new repository or using an existing one for your documentation.
+
+ ```bash
+ mkdir my-docs
+ cd my-docs
+ ```
+
+
+
+ Create an `index.mdx` file in your project root:
+
+ ```mdx index.mdx
+ ---
+ title: Welcome
+ description: Welcome to my documentation
+ ---
+
+ # Welcome to my docs
+
+ This is your first documentation page.
+ ```
+
+
+
+ Create a `docs.json` file to configure your site:
+
+ ```json docs.json
+ {
+ "name": "My Documentation",
+ "navigation": {
+ "pages": ["index"]
+ }
+ }
+ ```
+
+
+
+## Step 2: Connect to Mintlify
+
+
+
+ Connect your repository to automatically deploy changes
+
+
+ Set up your custom domain for professional branding
+
+
+
+## Step 3: Customize your site
+
+Once your basic site is running, you can:
+
+- **Add more pages** - Create additional `.mdx` files and add them to your navigation
+- **Style your site** - Configure themes and colors in your `docs.json`
+- **Add components** - Use Mintlify's built-in components for rich content
+- **Set up analytics** - Track how users interact with your documentation
+
+## Next steps
+
+
+ Learn about advanced installation options and local development
+
+
+## Need help?
+
+If you run into any issues:
+
+1. Check our [troubleshooting guide](/editor/troubleshooting)
+2. Browse our [component library](/components/accordions) for examples
+3. [Contact support](/contact-support) if you need assistance
+
+
+Your documentation will automatically update when you push changes to your connected repository.
+
\ No newline at end of file
From 8dc6dd0d2cc5001410446e04fc30c9eb8a97fdf9 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:11:28 +0000
Subject: [PATCH 10/14] Update docs.json
---
docs.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs.json b/docs.json
index 4ec2a7b61..cd9c57ed6 100644
--- a/docs.json
+++ b/docs.json
@@ -39,6 +39,7 @@
{
"group": "Core configuration",
"pages": [
+ "quickstart",
"settings",
"pages",
"navigation",
From 347069fefb69ccbb4490fb43688d0d17220c3694 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:12:03 +0000
Subject: [PATCH 11/14] Update quickstart.mdx
---
quickstart.mdx | 80 ++++++++------------------------------------------
1 file changed, 12 insertions(+), 68 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 0d6b0edd7..a8e5b7aec 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -3,92 +3,36 @@ title: Quickstart
description: Get started with Mintlify in minutes
---
-## Welcome to Mintlify
+## Get started
-Get your documentation site up and running in just a few minutes with this quickstart guide.
-
-## Prerequisites
-
-Before you begin, make sure you have:
-- A GitHub account
-- Basic familiarity with Markdown
-- Your documentation content ready
-
-## Step 1: Create your documentation
+Create your documentation in 3 steps:
-
- Start by creating a new repository or using an existing one for your documentation.
-
- ```bash
- mkdir my-docs
- cd my-docs
- ```
-
-
-
- Create an `index.mdx` file in your project root:
-
+
```mdx index.mdx
---
title: Welcome
- description: Welcome to my documentation
---
-
# Welcome to my docs
-
- This is your first documentation page.
```
-
- Create a `docs.json` file to configure your site:
-
+
```json docs.json
{
"name": "My Documentation",
- "navigation": {
- "pages": ["index"]
- }
+ "navigation": { "pages": ["index"] }
}
```
-
-
-## Step 2: Connect to Mintlify
-
-
-
- Connect your repository to automatically deploy changes
-
-
- Set up your custom domain for professional branding
-
-
-## Step 3: Customize your site
-
-Once your basic site is running, you can:
-
-- **Add more pages** - Create additional `.mdx` files and add them to your navigation
-- **Style your site** - Configure themes and colors in your `docs.json`
-- **Add components** - Use Mintlify's built-in components for rich content
-- **Set up analytics** - Track how users interact with your documentation
+
+ Link your repository in [GitHub settings](/settings/github) to deploy automatically.
+
+
## Next steps
-
- Learn about advanced installation options and local development
-
-
-## Need help?
-
-If you run into any issues:
-
-1. Check our [troubleshooting guide](/editor/troubleshooting)
-2. Browse our [component library](/components/accordions) for examples
-3. [Contact support](/contact-support) if you need assistance
-
-
-Your documentation will automatically update when you push changes to your connected repository.
-
\ No newline at end of file
+- Add more `.mdx` files and update navigation
+- Customize styling in `docs.json`
+- See [installation guide](/installation) for advanced options
\ No newline at end of file
From 65e1779634da33754872486c4b75bd43aa47aa3a Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:15:09 +0000
Subject: [PATCH 12/14] Update quickstart.mdx
---
quickstart.mdx | 34 +---------------------------------
1 file changed, 1 insertion(+), 33 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index a8e5b7aec..8888d5431 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -3,36 +3,4 @@ title: Quickstart
description: Get started with Mintlify in minutes
---
-## Get started
-
-Create your documentation in 3 steps:
-
-
-
- ```mdx index.mdx
- ---
- title: Welcome
- ---
- # Welcome to my docs
- ```
-
-
-
- ```json docs.json
- {
- "name": "My Documentation",
- "navigation": { "pages": ["index"] }
- }
- ```
-
-
-
- Link your repository in [GitHub settings](/settings/github) to deploy automatically.
-
-
-
-## Next steps
-
-- Add more `.mdx` files and update navigation
-- Customize styling in `docs.json`
-- See [installation guide](/installation) for advanced options
\ No newline at end of file
+Create `index.mdx`, add `docs.json` with navigation, then connect your GitHub repo in [settings](/settings/github).
\ No newline at end of file
From a3fc551897ef803ce27e9cc2468c742c31b923c5 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:16:02 +0000
Subject: [PATCH 13/14] Update quickstart.mdx
---
quickstart.mdx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 8888d5431..4692da7d8 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -3,4 +3,4 @@ title: Quickstart
description: Get started with Mintlify in minutes
---
-Create `index.mdx`, add `docs.json` with navigation, then connect your GitHub repo in [settings](/settings/github).
\ No newline at end of file
+Run `npx create-mintlify-app@latest` to get started.
\ No newline at end of file
From f133600ec6e797fd10f4cd7a03d12bb5881f9a25 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 17 Sep 2025 05:18:50 +0000
Subject: [PATCH 14/14] Update quickstart.mdx
---
quickstart.mdx | 29 +++++++++++++++++++++++++++--
1 file changed, 27 insertions(+), 2 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 4692da7d8..4f7f9f2a8 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -1,6 +1,31 @@
---
title: Quickstart
-description: Get started with Mintlify in minutes
+description: Create beautiful documentation in under 5 minutes
---
-Run `npx create-mintlify-app@latest` to get started.
\ No newline at end of file
+## Get started instantly
+
+
+
+ ```bash
+ npx create-mintlify-app@latest my-docs
+ cd my-docs
+ ```
+
+
+
+ ```bash
+ mintlify dev
+ ```
+
+
+
+ Open `introduction.mdx` and start writing your documentation.
+
+
+
+Your documentation site is now running at `localhost:3000`.
+
+
+ Deploy your docs to production with `mintlify deploy` or connect your GitHub repository for automatic deployments.
+
\ No newline at end of file