mintlify__docs/quickstart.mdx

---
title: "Quickstart"
description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git."
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
boost: 3
---

import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";

Deploy a documentation site and make your first change.

## Before you begin

Mintlify uses a docs-as-code approach: every page maps to a file in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored.">repository</Tooltip>. Edit locally or in the web editor and sync changes to your remote repository.

<Tip>
  Using an AI coding tool? Add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results.
</Tip>

<SkillMcpPrompt />

## Deploy your documentation site

Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. You'll connect GitHub, select a repository, and install the GitHub App for automatic deployments. Your site deploys to a `.mintlify.app` URL.

<AccordionGroup>
  <Accordion title="Optional: Skip connecting a Git provider during onboarding">
    Skip the Git provider connection to start quickly. Mintlify creates a private repository and configures the GitHub App for you, so you can use the web editor immediately. To migrate to your own repository later, use the Git setup wizard in [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings). See [Clone to your own repository](/deploy/github#clone-to-your-own-repository).
  </Accordion>
</AccordionGroup>

## View your deployed site

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

<Frame>
  <img
    alt="Overview page of the Mintlify dashboard."
    className="block dark:hidden"
    src="/images/quickstart/mintlify-domain-light.png"
  />
  <img
    alt="Overview page of the Mintlify dashboard."
    className="hidden dark:block"
    src="/images/quickstart/mintlify-domain-dark.png"
  />
</Frame>

<Tip>
  Before sharing with users, consider adding a [custom domain](/customize/custom-domain).
</Tip>

## Make your first change

<Tabs>
  <Tab title="CLI">
    <Steps>
      <Step title="Install the CLI">
        Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.

        <CodeGroup>

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

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

        </CodeGroup>

        See [Install the CLI](/cli/install) for details.
      </Step>
      <Step title="Clone your repository">
        Follow [Clone your repository](/cli/install#clone-your-repository) if you haven't already.
      </Step>
      <Step title="Edit a page">
        Update the description in `index.mdx`:

        ```mdx
        ---
        title: "Introduction"
        description: "Your custom description here"
        ---
        ```
      </Step>
      <Step title="Preview and push">
        Preview locally with `mint dev` at `http://localhost:3000`, then push to deploy:

        ```bash
        git add .
        git commit -m "Update description"
        git push
        ```
      </Step>
    </Steps>
  </Tab>
  <Tab title="Web editor">
    <Steps>
      <Step title="Open the web editor">
        Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
      </Step>
      <Step title="Edit a page">
        Open the **Introduction** page and update the description.

        <Frame>
          <img
            alt="Introduction page open in the web editor with the description edited to say Hello world!."
            className="block dark:hidden"
            src="/images/quickstart/hello-world-light.png"
          />
          <img
            alt="Introduction page open in the web editor with the description edited to say Hello world!."
            className="hidden dark:block"
            src="/images/quickstart/hello-world-dark.png"
          />
        </Frame>
      </Step>
      <Step title="Publish">
        Click **Publish** in the top-right. Check deployment status on the [Overview](https://dashboard.mintlify.com/) page.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
  Edit documentation in your browser and preview how your pages look when published.
</Card>

<Card title="Explore CLI commands" icon="terminal" horizontal href="/cli/index">
  Find broken links, check accessibility, validate OpenAPI specs, and more.
</Card>

<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
  Use your own domain for your documentation site.
</Card>