mintlify__docs/quickstart.mdx

---
title: "Quickstart"
description: "Deploy your documentation site and make your first change."
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
---

This guide walks you through deploying your documentation site and making your first update. You'll have a live site in minutes.

## Before you begin

Mintlify uses a docs-as-code approach. Every page on your site corresponds to a file in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>. You can edit files locally in your IDE or use the web editor in your browser.

<Tip>
  Using an AI coding tool like Cursor or Windsurf? Add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation.
</Tip>

<Prompt description="Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}>
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md
</Prompt>

## Deploy your documentation site

Go to [mintlify.com/start](https://mintlify.com/start) to begin the onboarding process:

1. Connect your GitHub account
2. Create or select a repository for your documentation
3. Install the GitHub App to enable automatic deployments

Your documentation site deploys automatically and becomes accessible at your `.mintlify.app` URL.

<AccordionGroup>
  <Accordion title="Skip GitHub connection during onboarding">
    Want to start immediately without connecting your own repository? Skip the GitHub connection during onboarding. Mintlify creates a private repository for you and automatically configures the GitHub App.

    You can migrate to your own repository later.
  </Accordion>
</AccordionGroup>

## View your deployed site

Your documentation site is live at `https://<your-project-name>.mintlify.app`.

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

<Frame>
  <img
    src="/images/quickstart/mintlify-domain-light.png"
    alt="Overview page showing the deployed documentation URL."
    className="block dark:hidden"
  />

  <img
    src="/images/quickstart/mintlify-domain-dark.png"
    alt="Overview page showing the deployed documentation URL."
    className="hidden dark:block"
  />
</Frame>

<Tip>
  Use this URL for testing and sharing with your team. Add a [custom domain](/customize/custom-domain) before sharing with users.
</Tip>

## Make your first change

<Tabs>
  <Tab title="CLI">
    <Steps>
      <Step title="Install the CLI">
        Install the Mintlify CLI globally. 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](/installation) for troubleshooting.
      </Step>
      <Step title="Clone your repository">
        Clone your documentation repository locally:

        ```bash
        git clone https://github.com/your-org/your-docs-repo.git
        cd your-docs-repo
        ```

        See [Clone your repository](/installation#clone-your-repository) for detailed instructions.
      </Step>
      <Step title="Edit a page">
        Open `index.mdx` and update the description:

        ```mdx index.mdx
        ---
        title: "Introduction"
        description: "Welcome to our documentation"
        ---
        ```
      </Step>
      <Step title="Preview locally">
        Start the development server:

        ```bash
        mint dev
        ```

        Open `http://localhost:3000` to preview your changes.
      </Step>
      <Step title="Deploy your changes">
        Commit and push to deploy:

        ```bash
        git add .
        git commit -m "Update description"
        git push
        ```

        Your changes deploy automatically. Check deployment status on the [Overview](https://dashboard.mintlify.com/) page.
      </Step>
    </Steps>
  </Tab>
  <Tab title="Web editor">
    <Steps>
      <Step title="Open the web editor">
        Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
      </Step>
      <Step title="Edit a page">
        Select the **Introduction** page from the sidebar and update the description.

        <Frame>
          <img
            src="/images/quickstart/hello-world-light.png"
            alt="Web editor showing the Introduction page with an updated description."
            className="block dark:hidden"
          />

          <img
            src="/images/quickstart/hello-world-dark.png"
            alt="Web editor showing the Introduction page with an updated description."
            className="hidden dark:block"
          />
        </Frame>
      </Step>
      <Step title="Publish your changes">
        Click **Publish** in the top-right corner.
      </Step>
      <Step title="View your changes">
        Check deployment status on the [Overview](https://dashboard.mintlify.com/) page. Once deployed, refresh your documentation site to see your changes.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Next steps

<CardGroup cols={2}>
  <Card title="Use the web editor" icon="mouse-pointer-2" href="/editor/index">
    Edit documentation in your browser with live preview.
  </Card>

  <Card title="Explore CLI commands" icon="terminal" href="/installation">
    Find broken links, validate OpenAPI specs, and more.
  </Card>

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

  <Card title="Customize your site" icon="paint-bucket" href="/customize/themes">
    Configure colors, fonts, and branding.
  </Card>
</CardGroup>