mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f9c0e5fb81
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
72 lines
2.5 KiB
Plaintext
72 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. Each page corresponds to a file in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>, which you can edit locally or in the web editor.
|
|
|
|
## Deploy your documentation site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. Connect your GitHub account, select a repository, and install the GitHub App for automatic deployments.
|
|
|
|
Your site deploys 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="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.
|
|
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
</Step>
|
|
<Step title="Edit a page">
|
|
Open `index.mdx` and update the description:
|
|
|
|
```mdx
|
|
---
|
|
title: "Introduction"
|
|
description: "Your custom description here"
|
|
---
|
|
```
|
|
</Step>
|
|
<Step title="Preview and deploy">
|
|
Preview locally with `mint dev`, then push your changes:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
<Tab title="Web editor">
|
|
<Steps>
|
|
<Step title="Edit a page">
|
|
Open the [web editor](https://dashboard.mintlify.com/editor), select the **Introduction** page, and update the description.
|
|
</Step>
|
|
<Step title="Publish">
|
|
Click **Publish** in the top-right toolbar. View deployment status on your [dashboard](https://dashboard.mintlify.com/).
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
|
|
Edit and preview documentation in your browser.
|
|
</Card>
|
|
|
|
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation">
|
|
Find broken links, 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 site.
|
|
</Card> |