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

# 快速入门

> 用不到 5 分钟开始构建优秀文档

<div id="setup-your-development">
  ## 设置开发环境
</div>

了解如何在本地更新文档并将其部署到公共环境。

<div id="edit-and-preview">
  ### 编辑与预览
</div>

<AccordionGroup>
  <Accordion icon="github" title="在本地克隆文档">
    在上手过程中，我们已在你的 GitHub 上创建了一个包含文档内容的仓库。你可以在我们的
    [dashboard](https://dashboard.mintlify.com) 找到该仓库。要将仓库克隆到本地，请在终端中按照
    [说明](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
    操作。
  </Accordion>

  <Accordion icon="rectangle-terminal" title="预览更改">
    预览可确保你的更改按预期显示。我们提供了一个命令行工具，可在本地渲染这些更改。1. 安装
    [Mintlify CLI](https://www.npmjs.com/package/mintlify)，并使用以下命令在本地预览文档更改：`npm i -g mintlify`
    2\. 在你的文档根目录（`mint.json` 所在位置）运行：`mintlify dev`
  </Accordion>
</AccordionGroup>

<div id="deploy-your-changes">
  ### 部署你的更改
</div>

<AccordionGroup>
  <Accordion icon="message-bot" title="安装我们的 GitHub 应用">
    我们的 GitHub 应用会自动将你的更改部署到文档站点，
    无需你手动管理部署。你可以在
    [控制台](https://dashboard.mintlify.com)找到安装链接。机器人
    成功安装后，仓库提交哈希旁会出现一个勾选标记。
  </Accordion>

  <Accordion icon="rocket" title="推送你的更改">
    [提交并推送更改到
    Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
    后，文档站点会更新这些更改。如果推送后未看到
    GitHub 应用成功完成部署，也可在我们的
    [控制台](https://dashboard.mintlify.com)手动更新文档。
  </Accordion>
</AccordionGroup>

<div id="update-your-docs">
  ## 更新文档
</div>

使用 MDX 语法和 React 组件直接在文件中添加内容。你可以使用我们的任意组件，也可以自行构建组件。

<CardGroup>
  <Card title="美化文档风格" icon="paintbrush" href="/zh/settings/global">
    通过个性化品牌为文档增色。
  </Card>

  <Card title="添加 API 端点" icon="square-code" href="/zh/api-playground/configuration">
    接入你的 OpenAPI 规范并启用交互式 API。
  </Card>

  <Card title="集成分析" icon="chart-mixed" href="/zh/analytics/supported-integrations">
    从用户与文档的交互中获取洞察。
  </Card>

  <Card title="托管到自定义域名" icon="browser" href="/zh/settings/custom-domain/subdomain">
    将文档托管在你的网站子域名上。
  </Card>
</CardGroup>