上游 · 理解本功能前需先掌握的(1):
下游 · 依赖/承接本功能的(0):
暂无下游(建议学完它再进阶)
前置依赖包含从属概念升级流程承接
边方向 = 学习顺序(A→B 表示先学 A 再学 B)
为什么需要它
心智模型
README 写不下所有细节,说明书、设计文档、使用指南这些长篇内容放哪?维基(Wiki)就是仓库自带的文档空间:每个人都可以像编辑网页一样协作写文档,把知识沉淀下来。它解决的是「项目用久了,经验记在哪里」的问题——不靠脑子记,靠大家一起维护的文档记。
历史背景 · 它为什么诞生诞生于 2008/2010
诞生项目文档需要与代码共存的协作空间。GitHub早期即提供wiki;2010-08-12重写为Git-backed wiki(每页是文件、每次修改是commit,基于Gollum开源库),支持Markdown等格式、diff历史与.wiki仓库克隆。
功能介绍
维基(Wiki)是 GitHub 仓库内置的协作式文档空间,每个仓库都可以开启一个独立的 Wiki,用来承载项目文档、使用指南、设计说明等长篇幅内容。它本质上是一个迷你站点:由多个页面(Page)组成,页面间可以互相链接,首页(Home)是默认入口。所有内容用 Markdown 编写,团队成员可以随时新建页面、编辑、甚至回到某个历史版本(History)。GitHub 还支持将 Wiki 仓库克隆到本地编辑再推送,这意味着它本质上也是一个 Git 仓库(以 .wiki.git 的形式存在),只是 GitHub 给了它友好的网页编辑界面。Wiki 很适合做「生长型文档」:README 负责开篇介绍,Wiki 负责持续维护的说明书与 FAQ。相比 Issues 和 Discussions,Wiki 的定位是「沉淀下来的知识」,而不是「进行中的对话」。
核心术语
维基(Wiki)页面(Page)首页(Home)历史版本(History)Markdown
适用场景
- 当项目有使用指南、API 说明、部署文档等长文档时,用 Wiki 页面组织。
- 当你想让团队共同维护项目文档时,开启 Wiki 让大家协作编辑。
- 当需要记录 FAQ、常见坑、设计决策时,在 Wiki 里建对应页面持续更新。
- 当 README 放不下又不想让文档散落在仓库目录时,把文档迁到 Wiki。
怎么操作(网页 vs 命令行 双轨)
🖱️ 网页操作 (GitHub.com)
- 进入仓库,点击 Settings → 勾选 Wiki 开启该功能。
- 回到仓库顶部点击 Wiki 标签,点击 New page 创建首页或新页面。
- 在编辑器里用 Markdown 撰写内容,点 Save page 保存。
- 需要修改时点 Edit、看历史版本点 History;可随时回滚到旧版本。
⌨️ 命令行 (进阶)
git clone https://github.com/你的账号/仓库名.wiki.gitcd 仓库名.wiki && echo "# 说明" > Home.mdgit add -A && git commit -m "更新维基"git push origin master
新手建议先从网页操作入手,熟悉概念后再尝试命令行。命令行是真实开发中更常用的方式。
与其他功能的关系
| 关系(前置依赖 / 包含从属 / 概念升级 / 流程承接) | 说明 |
|---|---|
| 前置依赖创建仓库(Create Repository) | 为仓库启用维基文档 |
官方文档
小结
SUMMARY
Wiki 是仓库的协作文档空间:多页面、Markdown 编写、可看历史版本,还支持克隆到本地编辑。README 管介绍,Wiki 管沉淀。到这里 G03、G04 十个功能节点全部讲完,可以进入下一批节点的学习了。