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

# 快速上手

> 几分钟内开始构建优秀文档

## 三步上手

让你的文档站点在本地运行，并完成你的第一次个性化设置。

### 步骤 1：设置本地环境

<AccordionGroup>
  <Accordion icon="copy" title="在本地克隆你的文档仓库">
    在注册引导过程中，如果你还没有文档仓库，我们会为你创建一个包含文档内容的 GitHub 仓库。你可以在[控制台](https://dashboard.mintlify.com)中找到该仓库的链接。

    若要在本地克隆仓库以便编辑并预览文档更改，请参考 GitHub 文档的[克隆仓库指南](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)。
  </Accordion>

  <Accordion icon="rectangle-terminal" title="启动预览服务器">
    1. 安装 Mintlify CLI：`npm i -g mint`
    2. 进入你的文档目录并运行：`mint dev`
    3. 打开 `http://localhost:3000` 实时查看文档！

    <Tip>当你编辑文件时，预览会自动更新。</Tip>
  </Accordion>
</AccordionGroup>

### 步骤 2：部署你的更改

<AccordionGroup>
  <Accordion icon="github" title="安装我们的 GitHub 应用">
    通过你的[控制台](https://dashboard.mintlify.com/settings/organization/github-app)安装 Mintlify GitHub 应用。

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

  <Accordion icon="palette" title="更新站点名称与配色">
    作为第一次更改，我们来更新站点名称与配色。

    1. 在编辑器中打开 `docs.json`。
    2. 将 `"name"` 字段改为你的项目名称。
    3. 更新 `"colors"` 以匹配你的品牌。
    4. 保存后，在 `http://localhost:3000` 即可立即看到变化。

    <Tip>试着修改 primary 颜色，你会立刻看到不同！</Tip>
  </Accordion>
</AccordionGroup>

### 步骤 3：正式上线

<Accordion icon="rocket" title="发布你的文档">
  1. 提交并推送你的更改。
  2. 片刻之后，你的文档就会更新并对外可见！
</Accordion>

## 下一步

文档跑起来后，继续探索这些关键功能：

<CardGroup cols={2}>
  <Card title="编写内容" icon="pen-to-square" href="/essentials/markdown">
    学习 MDX 语法，开始撰写文档。
  </Card>

  <Card title="自定义样式" icon="palette" href="/essentials/settings">
    让你的文档完美契合品牌形象。
  </Card>

  <Card title="添加代码示例" icon="square-code" href="/essentials/code">
    加入带语法高亮的代码块。
  </Card>

  <Card title="API 文档" icon="code" href="/api-reference/introduction">
    基于 OpenAPI 规范自动生成 API 文档。
  </Card>
</CardGroup>

<Note>
  **需要帮助？** 查看我们的[完整文档](https://mintlify.com/docs)或加入[社区](https://mintlify.com/community)。
</Note>