mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Kaishan (Sam) Ding
143 lines
5.1 KiB
Plaintext
143 lines
5.1 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Deploy your documentation site and make your first change."
|
|
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
|
|
---
|
|
|
|
<Info>
|
|
Welcome to the editor!
|
|
</Info>
|
|
|
|
After you complete this guide, you'll have a live documentation site ready to customize and update.
|
|
|
|
## Before you begin
|
|
|
|
Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.
|
|
|
|
When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any 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) for better results when updating your documentation.
|
|
</Tip>
|
|
|
|
<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"]'>
|
|
|
|
</Prompt>
|
|
|
|
## Deploy your documentation site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.
|
|
|
|
After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Optional: Skip connecting GitHub during onboarding">
|
|
If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.
|
|
|
|
This lets you use the web editor immediately and migrate to your own repository later.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## View your deployed site
|
|
|
|
Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.
|
|
|
|
Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
<Frame>
|
|
<img
|
|
className="hidden dark:block"
|
|
src="/images/quickstart/mintlify-domain-dark.png"
|
|
alt="Overview page of the Mintlify dashboard."
|
|
/>
|
|
<img
|
|
className="dark:hidden"
|
|
src="/images/quickstart/mintlify-domain-light.png"
|
|
alt="Overview page of the Mintlify dashboard."
|
|
/>
|
|
</Frame>
|
|
|
|
<Tip>
|
|
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
|
|
</Tip>
|
|
|
|
## 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
|
|
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
See [Install the CLI](/installation) 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](/installation#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>
|
|
</Tab>
|
|
<Tab title="Web editor">
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Next steps
|
|
|
|
<Card icon="mouse-pointer-2" horizontal href="/editor/index" title="Use the web editor">
|
|
Edit documentation in your browser and preview how your pages will look when published.
|
|
</Card>
|
|
|
|
<Card icon="terminal" horizontal href="/installation" title="Explore CLI commands">
|
|
Find broken links, check accessibility, validate OpenAPI specs, and more.
|
|
</Card>
|
|
|
|
<Card icon="globe" horizontal href="/customize/custom-domain" title="Add a custom domain">
|
|
Use your own domain for your documentation site.
|
|
</Card> |