mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Mintlify Agent
123 lines
3.7 KiB
Plaintext
123 lines
3.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"]
|
|
---
|
|
|
|
Get a live documentation site deployed and make your first edit.
|
|
|
|
## Deploy your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. Connect your GitHub account, select or create a repository, and install the GitHub App.
|
|
|
|
Your site deploys automatically to `https://<your-project-name>.mintlify.app`. Find the URL on your [dashboard](https://dashboard.mintlify.com/) **Overview** page.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Skip GitHub connection">
|
|
Skip connecting GitHub during onboarding to start immediately. Mintlify creates a private repository for you. Migrate to your own repository later.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Make your first edit
|
|
|
|
<Tabs>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
Requires [Node.js](https://nodejs.org/en) v20.17.0+. Install with npm or pnpm:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
See [Install the CLI](/installation) for details.
|
|
</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"
|
|
---
|
|
```
|
|
</Step>
|
|
<Step title="Preview locally">
|
|
Run from your documentation directory:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
View at `http://localhost:3000`.
|
|
</Step>
|
|
<Step title="Push changes">
|
|
Commit and push to deploy:
|
|
|
|
```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 editor">
|
|
Go to the [web editor](https://dashboard.mintlify.com/editor).
|
|
</Step>
|
|
<Step title="Edit a page">
|
|
Open the **Introduction** page 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 toolbar.
|
|
</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> |