mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
cef5ca3fdc
- Updated organize/hidden-pages.mdx - Updated customize/custom-domain.mdx - Updated workflows/enable.mdx - Updated index.mdx - Updated ai-native.mdx - Updated quickstart.mdx - Created images/Screenshot-2026-05-19-at-3.40.12-PM.png - Updated docs.json Mintlify-Source: dashboard-editor
75 lines
2.2 KiB
Plaintext
75 lines
2.2 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"]
|
|
boost: 3
|
|
---
|
|
|
|
import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";
|
|
|
|
<Card icon="sparkles">
|
|
</Card>
|
|
|
|
<br /><br />1. Deploy your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. You'll connect GitHub, select a repository, and install the GitHub App for automatic deployments.
|
|
|
|
Your site will be live at `https://<your-project-name>.mintlify.app`.
|
|
|
|
## 2. Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="Web editor">
|
|
<Steps>
|
|
<Step title="Open the web editor">
|
|
Go 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 **Publish** in the top-right toolbar.
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
Requires [Node.js](https://nodejs.org/en) v20.17.0\+.
|
|
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
</Step>
|
|
<Step title="Edit a page">
|
|
Open `index.mdx` and update the description in the frontmatter.
|
|
</Step>
|
|
<Step title="Preview locally">
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
View your preview at `http://localhost:3000`.
|
|
</Step>
|
|
<Step title="Push your changes">
|
|
```bash
|
|
git add . && git commit -m "Update description" && git push
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
|
|
Edit docs in your browser with a live preview.
|
|
</Card>
|
|
|
|
<Card title="Explore CLI commands" icon="terminal" horizontal href="/cli/index">
|
|
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 docs site.
|
|
</Card> |