跳到主要内容

Wiki

Wiki 是一个与代码仓库深度集成的在线文档系统，通过提供结构化的目录和版本化协作功能，协助研发团队高效构建、沉淀和共享与项目相关的各类非代码类知识资产。

适用场景与应用价值​

Wiki 适用于存储结构化、篇幅较长且需要持续维护的项目文档。当项目内容超出 README 文件所能承载的范围时，Wiki 是理想的知识管理工具。

场景具体说明
项目概览为新成员提供项目背景、业务目标及核心功能的快速入门指南。
环境搭建记录标准化的开发环境配置步骤及依赖安装指令，降低环境配置成本。
开发规范统一定义团队的代码风格、分支管理策略及提交规范。
API 文档阐述接口定义、参数规范与调用示例（适用于中小型项目，大型项目建议采用专业接口管理工具）。
部署指南记录项目发布流程、服务器配置要求及常见部署问题的应对方案。
会议纪要归档技术方案研讨记录、决策过程及后续待办事项。
故障复盘记录线上问题现象、根因分析报告及预防解决方案。

操作指南​

1、启用 Wiki 模块

进入【项目设置】—【基础设置】—【项目模块】，开启 Wiki 功能。

wiki-intro-setting-1

wiki-intro-setting-2

2、创建首个页面

点击导航栏中出现的【Wiki】入口，选择【+ Wiki 页面】即可开始编写文档。

wiki-intro-start

3、配置首页 (Home)

默认的 Home 文件是 Wiki 的门户页面，通常用于展示项目全局视图与核心信息。

wiki-intro-home

4、核心界面概览

界面主要功能模块说明如下：

wiki-introduction

5、配置侧边栏与超链接

_Sidebar.md 是Wiki的侧边栏配置文件，用于定义全局导航结构。通常在此文件中组织各页面的入口（如目录树或列表），并通过超链接实现快速跳转。平台会自动解析并识别Wiki 中已存在的页面文件，因此在编写链接时，既支持使用完整URL，也支持通过页面名称或文件名直接引用 Wiki 内部页面。

wiki-intro-sidebar

wiki-intro-link

6、配置页脚

_Footer.md 是 Wiki 的页脚配置文件，用于定义在 Wiki各页面底部统一展示的内容。通常用于放置通用信息与快捷入口，例如返回首页、相关文档链接、反馈渠道、维护者/更新时间及版权或许可声明等；保存后会自动应用到所有 Wiki 页面。

wiki-intro-pagefoot

架构规划与模板示例​

1. 文档架构规划参考

方案 A：基于目标人群分层

Wiki 首页（按人群分层）
├── 快速开始（面向所有成员）
├── 用户指南（面向系统用户）
├── 开发文档（面向研发人员）
├── 运维手册（面向系统管理员）
└── 贡献规范（面向研发与管理员）

方案 B：基于项目生命周期分层

Wiki 首页（按生命周期分层）
├── 快速开始
├── 开发阶段
├── 发布阶段
├── 运维保障
└── 常见问题 (FAQ)

2. 标准页面模板参考

# 用户指南（User Guide）- <项目名称>

> 面向对象：<普通用户/管理员/运营等>  
> 适用版本：<vX.Y>（文档更新于 <YYYY-MM-DD>）  
> 系统入口：<URL 或 客户端入口信息>

## 快速导航
1. 新手引导：请查阅 [[快速开始]](<url>)
2. 系统能力：请查阅 [[功能概览]](<url>)
3. 核心操作：
   - [[核心任务：创建与管理]](<url>)
   - [[核心任务：查询与导出]](<url>)
4. 技术支持：
   - [[故障排查指南 (Troubleshooting)]](<url>)
   - [[常见问题 (FAQ)]](<url>)

## 使用前置条件
- 账号开通：<描述获取方式>
- 权限申请：详情参见 [[权限与角色说明]](<url>)
- 环境要求：<说明适用的浏览器/网络环境/客户端版本>

## 知识库索引
- 功能与任务：[[功能概览]](<url>)、[[核心任务：创建与管理]](<url>)、[[核心任务：查询与导出]](<url>)
- 规则说明：[[字段与规则说明]](<url>)
- 权限体系：[[权限与角色说明]](<url>)
- 支持与帮助：[[故障排查指南 (Troubleshooting)]](<url>)、[[常见问题 (FAQ)]](<url>)、[[术语表]](<url>)

文件格式与解析规则​

GitCode Wiki 仅对特定格式的文件进行渲染，并将其纳入侧边栏导航目录。 当前支持解析的文件格式包括：

  • Markdown：.md、.markdown、.mdown、.mkdn
  • reStructuredText：.rst、.rest
  • Org-mode：.org

注意事项：

  • Wiki 代码仓库中不支持解析的文件（如图片、代码脚本等），依然会正常存储于 Wiki 代码仓库中。这类文件不会被渲染为 Wiki 页面，也不会显示在导航目录中。在对 Wiki 仓库执行 Clone 操作时，这些文件会被完整下载。
  • Wiki 页面的导航结构由侧边栏与页面间的超链接组成，而非底层仓库的文件夹层级。即使在本地 Wiki 仓库中创建了子文件夹，所有可渲染页面仍会以扁平方式纳入同一导航体系，文件夹路径不会反映在侧边栏结构中。建议通过编辑 _Sidebar 页面来定义导航层级，并在页面内使用内链关联相关内容。