mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2d9d772a19
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
50 lines
1.6 KiB
Plaintext
50 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 your documentation site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) to create your account and deploy your site. During 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
|
|
|
|
Edit documentation in the [web editor](https://dashboard.mintlify.com/editor) or locally with the CLI.
|
|
|
|
<Tabs>
|
|
<Tab title="Web editor">
|
|
1. Open the [web editor](https://dashboard.mintlify.com/editor)
|
|
2. Edit the **Introduction** page
|
|
3. Click **Publish**
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
Install the CLI:
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
|
|
Edit `index.mdx`, preview with `mint dev`, then push your changes:
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
</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 will 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> |