mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify-development[bot]
122 lines
4.3 KiB
Plaintext
122 lines
4.3 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";
|
|
|
|
Deploy a live documentation site and make your first change.
|
|
|
|
## Before you begin
|
|
|
|
Mintlify uses a docs-as-code approach: every page on your site has a corresponding file in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored.">repository</Tooltip>. Edit files locally or in the web editor and sync changes to your remote repository.
|
|
|
|
<Tip>
|
|
Using an AI coding tool? Copy the prompt below to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol).
|
|
</Tip>
|
|
|
|
<SkillMcpPrompt />
|
|
|
|
## Deploy your documentation 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 deploys to `https://<your-project-name>.mintlify.app`. Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Skip connecting a Git provider">
|
|
To get started without your own repository, skip the Git provider connection during onboarding. Mintlify creates a private repository and configures the GitHub App for you. Migrate to your own repository later from [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings). See [Clone to your own repository](/deploy/github#clone-to-your-own-repository).
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
<Tip>
|
|
Before sharing with users, add a [custom domain](/customize/custom-domain).
|
|
</Tip>
|
|
|
|
## Make your first change
|
|
|
|
<Tabs>
|
|
<Tab title="CLI">
|
|
<Steps>
|
|
<Step title="Install the CLI">
|
|
Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i -g mint
|
|
```
|
|
|
|
```bash pnpm
|
|
pnpm add -g mint
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
See [Install the CLI](/cli/install) for details.
|
|
</Step>
|
|
<Step title="Clone your repository">
|
|
Follow [Clone your repository](/cli/install#clone-your-repository) if you haven't already.
|
|
</Step>
|
|
<Step title="Edit and preview">
|
|
Update the `description` in `index.mdx`, then preview at `http://localhost:3000`:
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
</Step>
|
|
<Step title="Push your changes">
|
|
Commit and push to trigger a deployment:
|
|
|
|
```bash
|
|
git add .
|
|
git commit -m "Update description"
|
|
git push
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
</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 the Introduction page">
|
|
Open **Introduction** and update the description.
|
|
|
|
<Frame>
|
|
<img
|
|
alt="Introduction page open in the web editor with the description edited to say Hello world!."
|
|
className="block dark:hidden"
|
|
src="/images/quickstart/hello-world-light.png"
|
|
/>
|
|
<img
|
|
alt="Introduction page open in the web editor with the description edited to say Hello world!."
|
|
className="hidden dark:block"
|
|
src="/images/quickstart/hello-world-dark.png"
|
|
/>
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Publish">
|
|
Click **Publish** in the toolbar. Track deployment on the [Overview](https://dashboard.mintlify.com/) page.
|
|
</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 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>
|