维护指南

本指南用于帮助各位快速上手维护本站点。

如何开始维护

在顶部导航栏中，选择 关于 - 在线维护，即可使用浏览器维护本站点的内容。

图示

通过上面的方式打开以后，

打开 `接口管理`

通常你已经位于这里

找到对应的 MD 或接口文档

目录结构与帮助网站中一一对应。

打开文档并修改

如果你了解 Markdown，你能很快上手并维护。

并且 Apifox 提供了一些常用的格式，请自行尝试顶部工具栏中的各种格式效果。

有些文档是用目录维护的，请通过下面的方式：

保存修改

修改完成以后，点击右上角的 保存 按钮，或通过快捷键 ctrl + S / cmd + S 进行保存。

保存后的内容，将自动更新到帮助网站中。

在 `接口管理` 中选择对应的目录，点击【···】（或右键）打开目录菜单

图示

选择需要添加的类型完成创建

可通过创建 Markdown、API 接口、子目录维护本站内容。

这里建议所有创建 Markdown 场景，都使用 子目录 替代，方便维护目录结构。

Apifox 会按照 MD 文档、目录的顺序统一排序，不能进行混排。

目录可以在 文档 选项下维护 MD 内容，缺点是会带有折叠按钮，参考📱 移动端。

图示

整个目录结构共分为三大块：

中文文档目录

英文文档目录

思源 API 目录

分布对应本站顶部的 文档、API、English 三个主要内容。

关于站点结构的维护的说明，请至这里