mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
66 lines
1.7 KiB
Plaintext
66 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 your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) to connect GitHub and deploy your docs. Your site will be live at `<your-project-name>.mintlify.app`.
|
|
|
|
<Tip>
|
|
Using an AI coding tool? Add the [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results.
|
|
</Tip>
|
|
|
|
## Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
Requires [Node.js](https://nodejs.org/en) v20.17.0+.
|
|
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
</Step>
|
|
<Step title="Edit and preview">
|
|
Clone your repo, edit `index.mdx`, then preview:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
</Step>
|
|
<Step title="Deploy">
|
|
```bash
|
|
git add . && git commit -m "Update docs" && git push
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
<Tab title="Web editor">
|
|
<Steps>
|
|
<Step title="Edit">
|
|
Open the [web editor](https://dashboard.mintlify.com/editor) and modify any page.
|
|
</Step>
|
|
<Step title="Publish">
|
|
Click **Publish** in the toolbar.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<Card title="Web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
|
|
Edit and preview in your browser.
|
|
</Card>
|
|
|
|
<Card title="CLI commands" icon="terminal" horizontal href="/installation">
|
|
Validate links, accessibility, and OpenAPI specs.
|
|
</Card>
|
|
|
|
<Card title="Custom domain" icon="globe" horizontal href="/customize/custom-domain">
|
|
Use your own domain.
|
|
</Card>
|