mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
1c77559a99
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
58 lines
1.3 KiB
Plaintext
58 lines
1.3 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Deploy your documentation site and make your first change."
|
|
---
|
|
|
|
## Deploy your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) to create your documentation site. Connect your GitHub account and select a repository.
|
|
|
|
Your site deploys automatically to `https://<your-project-name>.mintlify.app`.
|
|
|
|
## Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="Web editor">
|
|
1. Open the [web editor](https://dashboard.mintlify.com/editor)
|
|
2. Edit the **Introduction** page
|
|
3. Click **Publish**
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
Install the CLI:
|
|
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
|
|
Edit `index.mdx` and preview locally:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
Push your changes:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Web editor" icon="mouse-pointer-2" href="/editor/index">
|
|
Edit in your browser
|
|
</Card>
|
|
<Card title="CLI commands" icon="terminal" href="/installation">
|
|
Work locally
|
|
</Card>
|
|
<Card title="Custom domain" icon="globe" href="/customize/custom-domain">
|
|
Add your domain
|
|
</Card>
|
|
<Card title="Navigation" icon="bars" href="/settings/navigation">
|
|
Organize your pages
|
|
</Card>
|
|
</CardGroup> |