mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
dade012036
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
33 lines
1.0 KiB
Plaintext
33 lines
1.0 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Deploy your documentation site and make your first change."
|
|
---
|
|
|
|
## Deploy your documentation site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) to deploy your site. You'll connect GitHub, select a repository, and install the GitHub App.
|
|
|
|
Your site deploys to `https://<your-project-name>.mintlify.app`. Find your URL on 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**
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
1. Install the CLI: `npm i -g mint`
|
|
2. Clone your repository
|
|
3. Edit `index.mdx`
|
|
4. Preview with `mint dev`
|
|
5. Push your changes: `git push`
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
- [Use the web editor](/editor/index) to edit in your browser
|
|
- [Install the CLI](/installation) for local development
|
|
- [Add a custom domain](/customize/custom-domain) for your site |