mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
c567c4ae19
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
57 lines
1.7 KiB
Plaintext
57 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"]
|
|
---
|
|
|
|
Deploy a live documentation site in minutes.
|
|
|
|
## Deploy your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding. Connect your GitHub account and select a repository for your documentation.
|
|
|
|
Your site deploys automatically to `https://<your-project-name>.mintlify.app`. Find your URL on the **Overview** page of your [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. View your changes live at your site URL
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
Install the CLI (requires [Node.js](https://nodejs.org/en) v20.17.0+):
|
|
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
|
|
Clone your repository, edit `index.mdx`, and preview locally:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
Push your changes to deploy:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<Card title="Web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
|
|
Edit and preview documentation in your browser
|
|
</Card>
|
|
<Card title="CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
|
|
Find broken links, check accessibility, and validate OpenAPI specs
|
|
</Card>
|
|
<Card title="Custom domain" icon="globe" horizontal href="/customize/custom-domain">
|
|
Use your own domain for your site
|
|
</Card> |