| 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 |
|
|||||||
| boost | 3 |
import SetupAgentPrompt from "/snippets/setup-agent-prompt.mdx"; import AgentSetupWorkflow from "/snippets/agent-setup-workflow.mdx";
After you complete this guide, you'll have a live documentation site ready to customize and update.
Using an AI agent?Copy the following prompt to have your agent set up your site for you. It directs your agent to create your account and deploy your site. It also adds the Mintlify [skill](/ai/skillmd) and [Model Context Protocol (MCP) server](/ai/model-context-protocol) for better results when you update your content.
The prompt splits the quickstart into tasks your agent can complete and directs it to ask you for any information it needs while getting everything set up.
{/* vale Mintlify.OxfordComma = NO */}
{/* vale Mintlify.OxfordComma = YES */}Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository.
When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you name your project and answer a few questions about how you plan to use it. You can also connect your GitHub account and install the GitHub App to enable automatic deployments.In the final onboarding step, describe the docs that you want to build. You can add links to your existing site, upload files, or select GitHub repositories to use as sources. The Mintlify agent generates a starting point for your docs while you watch a live preview. Answer any questions the agent asks to refine the result. To start with placeholder content instead, select Skip, start from a blank template.
After onboarding, your documentation site deploys and is accessible at your .mintlify.site URL.
This lets you use the web editor immediately. If you want to use your own repository later, go to [Git Settings](https://app.mintlify.com/settings/project/git-settings) in your dashboard to migrate your content using the Git setup wizard. See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details.
Your documentation site is now deployed at https://<your-project-name>.mintlify.site.
Find your exact URL on the Overview page of your dashboard.
<CodeGroup>
```bash npm
npm i -g mint
```
```bash pnpm
pnpm add -g mint
```
</CodeGroup>
See [Install the CLI](/cli/install) for full details and troubleshooting.
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, clone it using Git:
```bash
git clone <your-repository-url>
```
If your repository is in Mintlify's private organization, see [Clone to your own repository](/deploy/github#clone-to-your-own-repository) to move it to your account first.
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:
```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:
```bash
mint dev
```
View your preview at `http://localhost:3000`.
</Step>
<Step title="Push your changes">
Commit and push your changes to trigger a deployment:
```bash
git add .
git commit -m "Update description"
git push
```
Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://app.mintlify.com/) page of your dashboard.
</Step>
</Steps>
<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 of the web editor toolbar.
</Step>
<Step title="View live">
On the [Overview](https://app.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
</Step>
</Steps>