GitHub 集成
让读者直接跳转到 GitHub 上编辑任何页面——让社区贡献变得轻松。
设置#
| 设置 | 作用 |
|---|---|
| 显示“在 GitHub 上编辑” | 在每页底部添加编辑链接 |
| GitHub 编辑基础 URL | 编辑链接的基本路径 |
如何启用#
- 打开您的文档站点。
- 浮动小部件 → 设计 → 内容 选项卡。
- 启用 显示“在 GitHub 上编辑”。
- 设置 GitHub 编辑基础 URL（见下文）。
- 保存。
设置编辑基本 URL#
编辑基本 URL 告诉 Docsbook 当读者点击“在 GitHub 上编辑”时，将他们发送到哪里。
格式：
https://github.com/{username}/{repo}/edit/{branch}/{docs-folder}
示例：
| 仓库 | Docs 位置 | 编辑基本 URL |
|---|---|---|
myname/my-repo |
仓库根目录 | https://github.com/myname/my-repo/edit/main |
myname/my-repo |
/docs 文件夹 |
https://github.com/myname/my-repo/edit/main/docs |
myname/my-repo |
master 分支 |
https://github.com/myname/my-repo/edit/master |
Docsbook 会自动将当前页面路径附加到此基本 URL。
如果您不填写此字段，Docsbook 将使用基于您的仓库的合理默认值。
为什么启用它?#
对于开源项目，"在 GitHub 上编辑" 链接至关重要——它允许社区成员只需单击一下即可修复错别字、澄清说明和改进示例。
对于团队文档，它允许任何团队成员提出改进建议，而无需了解 Docsbook 的工作原理——他们只需直接在 GitHub 上编辑文件即可。
将您的读者变成贡献者。 连接您的 GitHub 仓库 →