mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
c1c32500ba
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
129 lines
3.6 KiB
Plaintext
129 lines
3.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"]
|
|
---
|
|
|
|
Complete this guide to deploy a live documentation site ready to customize.
|
|
|
|
## Deploy your documentation site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and connect your GitHub account. Select or create a repository and install the GitHub App for automatic deployments.
|
|
|
|
Your site deploys to `<your-project-name>.mintlify.app`.
|
|
|
|
## View your deployed site
|
|
|
|
Find your URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/quickstart/mintlify-domain-light.png"
|
|
alt="Overview page of the Mintlify dashboard."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/quickstart/mintlify-domain-dark.png"
|
|
alt="Overview page of the Mintlify dashboard."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
## Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
Requires [Node.js](https://nodejs.org/en) v20.17.0+.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
|
|
</CodeGroup>
|
|
</Step>
|
|
<Step title="Clone your repository">
|
|
Clone your repository locally. See [Clone your repository](/installation#clone-your-repository).
|
|
</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 locally">
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
View at `http://localhost:3000`.
|
|
</Step>
|
|
<Step title="Push your changes">
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
|
|
View deployment status on your [dashboard](https://dashboard.mintlify.com/).
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
<Tab title="Web editor">
|
|
<Steps>
|
|
<Step title="Open the web editor">
|
|
Go to the [web editor](https://dashboard.mintlify.com/editor).
|
|
</Step>
|
|
<Step title="Edit a page">
|
|
Open **Introduction** and update the description.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/quickstart/hello-world-light.png"
|
|
alt="Introduction page open in the web editor with the description edited to say Hello world!."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/quickstart/hello-world-dark.png"
|
|
alt="Introduction page open in the web editor with the description edited to say Hello world!."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Publish">
|
|
Click **Publish** in the top-right.
|
|
</Step>
|
|
<Step title="View live">
|
|
Check deployment status on your [dashboard](https://dashboard.mintlify.com/). Refresh your site when complete.
|
|
</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 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> |