mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
c104acb591
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
92 lines
2.5 KiB
Plaintext
92 lines
2.5 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 connect your GitHub account. Select or create a repository for your documentation and install the GitHub App.
|
|
|
|
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/).
|
|
|
|
<Tip>
|
|
**Public GitHub repo?** Replace `github.com` with `mintlify.com` in your repository URL to [auto-generate your site](https://mintlify.com/explore).
|
|
</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 or higher.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
|
|
</CodeGroup>
|
|
</Step>
|
|
<Step title="Clone and edit">
|
|
Clone your repository and open `index.mdx`. Update the description:
|
|
|
|
```mdx
|
|
---
|
|
title: "Introduction"
|
|
description: "Your custom description here"
|
|
---
|
|
```
|
|
</Step>
|
|
<Step title="Preview locally">
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
View at `http://localhost:3000`.
|
|
</Step>
|
|
<Step title="Deploy">
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
|
|
Your changes deploy automatically.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
<Tab title="Web editor">
|
|
<Steps>
|
|
<Step title="Open the editor">
|
|
Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
|
|
</Step>
|
|
<Step title="Edit and publish">
|
|
Open the **Introduction** page, update the description, and click **Publish**.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
|
|
Edit documentation in your browser and preview how your pages look when published.
|
|
</Card>
|
|
|
|
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation">
|
|
Find broken links, check accessibility, validate OpenAPI specs, and more.
|
|
</Card>
|
|
|
|
<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
|
|
Use your own domain for your documentation site.
|
|
</Card> |