mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
118 lines
4.4 KiB
Plaintext
118 lines
4.4 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git."
|
|
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
|
|
---
|
|
|
|
## Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
See [Install the CLI](/cli/install) for full details and troubleshooting.
|
|
</Step>
|
|
<Step title="Clone your repository">
|
|
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository).
|
|
</Step>
|
|
<Step title="Edit a page">
|
|
Open `index.mdx` in your preferred editor and update the description in the frontmatter:
|
|
|
|
```mdx
|
|
---
|
|
title: "Introduction"
|
|
description: "Your custom description here"
|
|
---
|
|
```
|
|
</Step>
|
|
<Step title="Preview locally">
|
|
Run the following command from your documentation directory:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
View your preview at `http://localhost:3000`.
|
|
</Step>
|
|
<Step title="Push your changes">
|
|
Commit and push your changes to trigger a deployment:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
|
|
Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Prompt description="Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:
|
|
|
|
npx skills add https://mintlify.com/docs
|
|
|
|
Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}>
|
|
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:
|
|
|
|
npx skills add https://mintlify.com/docs
|
|
|
|
Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md
|
|
</Prompt>
|
|
</Tab>
|
|
<Tab title="Web editor">
|
|
<Steps>
|
|
<Step title="Open the web editor">
|
|
Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
|
|
</Step>
|
|
<Step title="Edit a page">
|
|
Open the **Introduction** page and update the description.
|
|
</Step>
|
|
<Step title="Publish">
|
|
Click the **Publish** button in the top-right of the web editor toolbar.
|
|
</Step>
|
|
<Step title="View live">
|
|
On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Prompt description="Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:
|
|
|
|
npx skills add https://mintlify.com/docs
|
|
|
|
Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}>
|
|
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:
|
|
|
|
npx skills add https://mintlify.com/docs
|
|
|
|
Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md
|
|
</Prompt>
|
|
</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="/cli/index">
|
|
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> |