Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 73 additions & 149 deletions quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,223 +1,160 @@
---
title: "Quickstart"
description: "Deploy your documentation site and make your first changes."
keywords: ["quickstart","deploy","get started","first steps"]
description: "Get your documentation site live in minutes."
---

After completing this guide, you will have a live documentation site ready to customize and expand.

<Info>
**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.
**Prerequisite**: [Create an account](https://mintlify.com/start) and complete onboarding before starting.
</Info>

## Getting started
## Your live site

After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format:
After onboarding, your site deploys automatically to:

```
https://<your-project-name>.mintlify.app
```

Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/).
Find your URL on the [dashboard](https://dashboard.mintlify.com/) Overview page.

<Frame>
<img
src="/images/quickstart/mintlify-domain-light.png"
alt="Mintlify Domain"
className="block dark:hidden"
/>

<img
src="/images/quickstart/mintlify-domain-dark.png"
alt="Mintlify Domain"
className="hidden dark:block"
/>
</Frame>

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

Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
## Connect GitHub

Install the GitHub App by following the instructions from the onboarding checklist or your dashboard.
Install the GitHub App to enable automatic deployments when you push changes.

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. Select **Install GitHub App**.
3. Choose your organization and select the repositories to connect.

<Frame>
<img
src="/images/quickstart/github-app-installation-light.png"
alt="GitHub App Installation"
className="block dark:hidden"
/>

<img
src="/images/quickstart/github-app-installation-dark.png"
alt="GitHub App Installation"
className="hidden dark:block"
/>
</Frame>

<Info>
Update the GitHub App permissions if you move your documentation to a different repository.
</Info>

### 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.

<Info>
An admin for your GitHub organization may need to authorize your account depending on your organization settings.
</Info>

## Editing workflows
Then authorize your GitHub account under **Settings** → **My Profile** → **Authorize GitHub account**.

Check warning on line 54 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L54

Avoid first-person pronouns such as 'My'.

Mintlify offers two workflows for creating and maintaining your documentation:
## Choose your workflow

<Card title="Code-based workflow" icon="terminal" horizontal href="#code-based-workflow">
For users who prefer working with existing tools in their local environment. Click to jump to this section.
</Card>

<Card title="Web editor workflow" icon="mouse-pointer-2" horizontal href="#web-editor-workflow">
For users who prefer a visual interface in their web browser. Click to jump to this section.
</Card>
<CardGroup cols={2}>
<Card title="Code-based" icon="terminal" href="#code-based-workflow">
Edit locally with Git and your preferred tools.
</Card>
<Card title="Web editor" icon="mouse-pointer-2" href="#web-editor-workflow">
Edit directly in your browser with a visual interface.
</Card>
</CardGroup>

## Code-based workflow

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.

### Install the CLI

Check warning on line 69 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L69

Use 'command-line tool' instead of 'CLI'.

<Info>
**Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher through v24. LTS versions are preferred.
Requires [Node.js](https://nodejs.org/en) v20.17.0+ (up to v24). LTS versions recommended.

Check warning on line 72 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L72

Use parentheses judiciously.

Check warning on line 72 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L72

Spell out 'LTS', if it's unfamiliar to the audience.
</Info>

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:

<CodeGroup>

```bash npm
npm i -g mint
```


```bash pnpm
pnpm add -g mint
```

</CodeGroup>

### Create a new project
### Create a project

Run `mint new` to create a new documentation project. See the [CLI installation guide](/installation#create-a-new-project) for details on the command and flags.
```bash
mint new
```

### Edit the documentation
See the [CLI guide](/installation#create-a-new-project) for available options.

After setting up your project, you can start editing your documentation files. For example, update the title of the introduction page:
### Make your first edit

1. Navigate to your documentation repository.
2. Open `index.mdx` and locate the top of the file:
Open `index.mdx` and change the title:

```mdx index.mdx
---
title: "Introduction"
description: "This is the introduction to the documentation"
---
```

3. Update the `title` field to `"Hello World"`.

```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:
### Preview locally

```bash
mint dev
```

Your preview is available at `localhost:3000`.
View your changes at `localhost:3000`.

<Frame>
<img
src="/images/quickstart/mintlify-dev-light.png"
alt="Mintlify Dev"
className="block dark:hidden"
/>

<img
src="/images/quickstart/mintlify-dev-dark.png"
alt="Mintlify Dev"
className="hidden dark:block"
/>
</Frame>

### Push the changes

When you are ready to publish your changes, push them to your repository.

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).

After the deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.
### Deploy

<Card title="Jump to adding a custom domain" icon="arrow-down" horizontal href="#adding-a-custom-domain">
Optionally, skip the web editor workflow and jump to adding a custom domain.
</Card>
Push your changes to GitHub. Mintlify automatically builds and deploys your site. Track progress in your [dashboard](https://dashboard.mintlify.com) or GitHub commit history.

## Web editor workflow

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.
### Open the editor

### Access the web editor

1. Log in to your [dashboard](https://dashboard.mintlify.com).
2. Select **Editor** on the left sidebar.

<Info>
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
</Info>
Go to your [dashboard](https://dashboard.mintlify.com) and select **Editor** in the sidebar.

<Frame>
<img
alt="The Mintlify web editor in the visual editor mode"
alt="The Mintlify web editor"
src="/images/quickstart/web-editor-light.png"
className="block dark:hidden"
/>

<img
alt="The Mintlify web editor in the visual editor mode"
alt="The Mintlify web editor"
src="/images/quickstart/web-editor-dark.png"
className="hidden dark:block"
/>
</Frame>

### Edit the documentation

In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:
### Make your first edit

Find and select `index.mdx` in the file explorer.

Then, in the editor, update the title field to "Hello World".
Select `index.mdx` from the file explorer and change the title to "Hello World".

Check warning on line 150 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L150

Commas and periods go inside quotation marks.

<Frame>
<img
alt="Editing in Web Editor"
src="/images/quickstart/web-editor-editing-light.png"
className="block dark:hidden"
/>

<img
alt="Editing in Web Editor"
src="/images/quickstart/web-editor-editing-dark.png"
Expand All @@ -226,89 +163,76 @@
</Frame>

<Tip>
The editor provides a rich set of formatting tools and components. Type <kbd>/</kbd>

in the editor to open the command menu and access these tools.
Type <kbd>/</kbd> to open the command menu for formatting tools and components.
</Tip>

### Publish your changes
### Publish

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.
Select **Publish** in the top-right corner to deploy your changes immediately.

<Tip>
Use branches to preview and review changes through pull requests before deploying to your live site.
Use [branches](/editor) to preview changes before deploying to production.
</Tip>

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).
## Add a custom domain

## Adding a custom domain
Replace your `.mintlify.app` subdomain with your own domain.

While your `<your-project-name>.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
1. Go to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard.
2. Enter your domain (e.g., `docs.yourcompany.com`).

Check warning on line 182 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L182

Use parentheses judiciously.

Check warning on line 182 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L182

Use 'for example' instead of 'e.g.'.
3. Add this DNS record with your domain provider:

To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
| Record Type | Name | Value | TTL |
| ----------- | ------------------- | -------------------- | ---- |
| CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 |

Check warning on line 187 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L187

Use parentheses judiciously.

<Frame>
<img
src="/images/quickstart/custom-domain-light.png"
alt="Custom Domain"
className="block dark:hidden"
/>

<img
src="/images/quickstart/custom-domain-dark.png"
alt="Custom Domain"
className="hidden dark:block"
/>
</Frame>

Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider.

<Table>
| Record Type | Name | Value | TTL |
| ----------- | ------------------- | -------------------- | ---- |
| CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 |
</Table>

<Info>
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
DNS changes can take up to 48 hours to propagate.
</Info>

## Next steps

Check warning on line 206 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L206

'Next steps' should use sentence-style capitalization.

Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:

<Card title="Configure your global settings" icon="settings" horizontal href="organize/settings">
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
</Card>

<Card title="Customize your theme" icon="paintbrush" horizontal href="customize/themes">
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
</Card>

<Card title="Organize navigation" icon="map" horizontal href="organize/navigation">
Structure your documentation with intuitive navigation to help users find what they need.
</Card>

<Card title="Add interactive components" icon="puzzle" horizontal href="/components/accordions">
Enhance your documentation with interactive components like accordions, tabs, and code samples.
</Card>

<Card title="Set up API references" icon="code" horizontal href="/api-playground/overview">
Create interactive API references with OpenAPI and AsyncAPI specifications.
</Card>
<CardGroup cols={2}>
<Card title="Configure settings" icon="settings" href="organize/settings">
Set up styling, navigation, and integrations in `docs.json`.
</Card>
<Card title="Customize theme" icon="paintbrush" href="customize/themes">
Adjust colors, fonts, and appearance.
</Card>
<Card title="Organize navigation" icon="map" href="organize/navigation">
Structure your docs for easy discovery.
</Card>
<Card title="Add components" icon="puzzle" href="/components/accordions">
Use accordions, tabs, code samples, and more.
</Card>
<Card title="Set up API docs" icon="code" href="/api-playground/overview">
Create interactive API references from OpenAPI specs.
</Card>
</CardGroup>

## Troubleshooting

If you encounter issues during the setup process, check these common troubleshooting solutions:

<AccordionGroup>
<Accordion title="Local preview not working">
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 Node.js v20.17.0+ is installed and run `mint dev` from the directory containing `docs.json`.

Check warning on line 230 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L230

In general, use active voice instead of passive voice ('is installed').
</Accordion>
<Accordion title="Changes not reflecting on live site">
Deployment can take up 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.
<Accordion title="Changes not appearing on live site">
Deployments take a few minutes. Check your dashboard for build errors.
</Accordion>
<Accordion title="Custom domain not connecting">
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 DNS records are correct and allow up to 48 hours for propagation. Use [DNSChecker](https://dnschecker.org) to verify your CNAME record.
</Accordion>
</AccordionGroup>
</AccordionGroup>