Wiki
每个存储库都可以托管一个 Wiki,即一组独立的 Markdown 页面,用于存放与代码并存但不混入代码的文档。
启用 Wiki
Section titled “启用 Wiki”- 打开存储库并选择设置。
- 在功能下,打开 Wiki。
- 存储库导航中会出现 Wiki 选项卡。
创建和编辑页面
Section titled “创建和编辑页面”- 选择 Wiki 选项卡。
- 如果 Wiki 还没有页面,请选择 Create the First Page;否则选择 New Page。
- 输入页面标题。标题会成为页面的 URL,因此请选择清晰且稳定的名称。
- 使用 Markdown 撰写内容,然后选择 Save Page。
创建的第一个页面会成为 Wiki 的主页,即访问者默认进入的页面。要更新现有页面,请打开它并选择编辑。每次保存都会在页面的修订历史中记录一个新条目。
组织 Wiki
Section titled “组织 Wiki”两个特殊命名的页面控制整个 Wiki 的导航:
- _Sidebar:显示在每个页面上的自定义侧边栏。在此添加指向最重要页面的链接。
- _Footer:显示在每个页面底部的页脚。
使用上面显示的确切名称,通过 New Page 创建其中任意一个。使用标准 Markdown 在 Wiki 页面之间建立链接,引用页面 slug:
See the [Setup Guide](setup-guide) for installation steps.从一开始就使用描述性的页面标题:标题会成为 URL,之后重命名页面会使指向它的现有链接失效。
在本地编辑 Wiki
Section titled “在本地编辑 Wiki”Wiki 本身就是一个 Git 存储库,可通过存储库的 .wiki.git URL 访问。克隆它,在编辑器中编辑 Markdown 文件,然后将更改推送回去。
git clone https://git.example.plaidcloud.com/you/my-repo.wiki.gitcd my-repo.wiki# edit or add .md filesgit add .git commit -m "Expand the setup guide"git push用于主存储库的同一个个人访问令牌在这里同样有效。每个 Markdown 文件都会成为一个 Wiki 页面,文件名(不含 .md 扩展名)即页面 slug。