mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2ab251a17c
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
47 lines
1.6 KiB
Plaintext
47 lines
1.6 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 and make your first edit.
|
|
|
|
## Deploy your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and connect your GitHub account. Mintlify will create a repository and deploy your site to `https://<your-project-name>.mintlify.app`.
|
|
|
|
Find your URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
## Make your first edit
|
|
|
|
<Tabs>
|
|
<Tab title="Web editor">
|
|
1. Open the [web editor](https://dashboard.mintlify.com/editor) in your dashboard
|
|
2. Edit the **Introduction** page description
|
|
3. Click **Publish** to deploy your changes
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
1. Install the CLI: `npm i -g mint`
|
|
2. Clone your repository and open `index.mdx`
|
|
3. Update the description in the frontmatter
|
|
4. Run `mint dev` to preview at `http://localhost:3000`
|
|
5. Push your changes: `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 with live preview
|
|
</Card>
|
|
<Card title="CLI commands" icon="terminal" href="/installation">
|
|
Local development and validation tools
|
|
</Card>
|
|
<Card title="Custom domain" icon="globe" href="/customize/custom-domain">
|
|
Use your own domain
|
|
</Card>
|
|
<Card title="Navigation" icon="bars" href="/navigation">
|
|
Organize your documentation
|
|
</Card>
|
|
</CardGroup> |