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

# 快速开始

> 几分钟内开始构建高质量文档

## 三步开始使用

在本地跑起文档站点，并完成第一次自定义配置。

### 第 1 步：准备本地环境

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

    要将仓库克隆到本地，以便修改并预览文档变更，请参考 GitHub 文档中的 [Cloning a repository](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 App">
    在你的 [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) 安装 Mintlify GitHub App。

    GitHub App 会自动将你的更改部署到文档站点，因此你无需手动管理部署流程。
  </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. 提交（commit）并推送（push）你的更改。
  2. 你的文档会在片刻后更新并上线！
</Accordion>

## 下一步

现在你已经把文档跑起来了，可以继续探索这些关键功能：

<CardGroup cols={2}>
  <Card title="编写内容" icon="pen-to-square" href="/usage-guide/writing-content/markdown">
    学习 MDX/Markdown 语法并开始编写文档。
  </Card>

  <Card title="定制样式" icon="palette" href="/usage-guide/customization/settings">
    让文档外观与品牌风格保持一致。
  </Card>

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

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

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