mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Mintlify Agent
56 lines
1.7 KiB
Plaintext
56 lines
1.7 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Deploy your documentation site and make your first change."
|
|
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
|
|
---
|
|
|
|
Get your documentation site live in minutes.
|
|
|
|
## Deploy your site
|
|
|
|
1. Go to [mintlify.com/start](https://mintlify.com/start)
|
|
2. Connect your GitHub account
|
|
3. Create or select a repository
|
|
4. Install the GitHub App
|
|
|
|
Your site is now live at `https://<your-project-name>.mintlify.app`. Find your URL in the [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
## Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="Web editor">
|
|
1. Open the [web editor](https://dashboard.mintlify.com/editor)
|
|
2. Edit the **Introduction** page description
|
|
3. Click **Publish**
|
|
4. Refresh your site to see changes live
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
Install the CLI (requires [Node.js](https://nodejs.org/en) v20.17.0+):
|
|
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
Clone your repository, edit `index.mdx`, then push:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
|
|
See [Install the CLI](/installation) for details.
|
|
</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 will look when published.
|
|
</Card>
|
|
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
|
|
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> |