> ## Documentation Index
> Fetch the complete documentation index at: https://doc.tianhao.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# 快速入门

> 几分钟内开始构建令人惊叹的文档

## Get started in three steps

Get your documentation site running locally and make your first customization.

### Step 1: Set up your local environment

<AccordionGroup>
  <Accordion icon="copy" title="Clone your docs locally">
    During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com).

    在入职过程中，如果您之前没有创建过，您已经创建了一个包含文档内容的GitHub仓库。您可以在您的[仪表板](https://dashboard.mintlify.com)中找到该仓库的链接。
    To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs.

    要本地克隆仓库以便您能够制作和预览对文档的更改，请遵循GitHub文档中的[克隆仓库](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)指南。
  </Accordion>

  <Accordion icon="rectangle-terminal" title="Start the preview server">
    1. Install the Mintlify CLI: `npm i -g mint`

    2. Navigate to your docs directory and run: `mint dev`

    3. Open `http://localhost:3000` to see your docs live!

    4. 安装 Mintlify CLI: `npm i -g mint`

    5. 切换到您的文档目录并运行: `mint dev`

    6. 打开 `http://localhost:3000` 查看您的文档实时效果！
       <Tip>您的预览会自动更新，当您编辑文件时.</Tip>
  </Accordion>
</AccordionGroup>

### Step 2: Deploy your changes

<AccordionGroup>
  <Accordion icon="github" title="Install our GitHub app">
    Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

    从您的[仪表板](https://dashboard.mintlify.com/settings/organization/github-app)安装 Mintlify GitHub 应用程序。

    Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself.

    我们的GitHub应用会自动将您的更改部署到您的文档网站上，因此您无需自行管理部署。
  </Accordion>

  <Accordion icon="palette" title="Update your site name and colors">
    For a first change, let's update the name and colors of your docs site.

    首先，让我们更新您文档网站的名称和颜色。

    1. Open `docs.json` in your editor.

    2. Change the `"name"` field to your project name.

    3. Update the `"colors"` to match your brand.

    4. Save and see your changes instantly at `http://localhost:3000`.

    5. 在您的编辑器中打开 `docs.json`。

    6. 将 `"name"` 字段更改为您的项目名称。

    7. 更新 `"colors"` 以匹配您的品牌。

    8. 保存并立即在 `http://localhost:3000` 查看您的更改。

    <Tip>尝试更改主色调以立即看到差异！</Tip>
  </Accordion>
</AccordionGroup>

### Step 3: Go live

<Accordion icon="rocket" title="Publish your docs">
  1. Commit and push your changes.

  2. 提交并推送你的更改。

  3. Your docs will update and be live in moments!

  4. 您的文档将立即更新并实时生效！
</Accordion>

## 下一步

现在您已经启动了您的文档，探索这些关键功能：

<CardGroup cols={2}>
  <Card title="Write Content" icon="pen-to-square" href="/essentials/markdown">
    Learn MDX syntax and start writing your documentation.

    学习MDX语法，开始编写您的文档。
  </Card>

  <Card title="Customize style" icon="palette" href="/essentials/settings">
    Make your docs match your brand perfectly.

    让您的文档与您的品牌完美匹配。
  </Card>

  <Card title="Add code examples" icon="square-code" href="/essentials/code">
    Include syntax-highlighted code blocks.

    包括语法高亮的代码块。
  </Card>

  <Card title="API documentation" icon="code" href="/api-reference/introduction">
    Auto-generate API docs from OpenAPI specs.

    自动从OpenAPI规范生成API文档。
  </Card>
</CardGroup>

<Note>
  **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community).
</Note>