添加“在 GitHub 上编辑”链接
在 GitHub 上编辑链接会显示在 Docsbook 网站每个页面的底部，并在 GitHub 编辑器中打开该页面的源文件。发现拼写错误的读者无需了解 Docsbook 的任何信息，即可修复错误并创建拉取请求。
在找其他内容？本页面介绍面向读者的编辑链接。要连接 GitHub 账户，或将托管在 Docsbook 上的项目移入你拥有的代码仓库，请打开 AI 聊天标题栏中的项目选择器，然后使用已连接的代码仓库——请参阅快速入门。
这两个设置的作用#
| 设置 | 作用 |
|---|---|
| 在 GitHub 上编辑 | 在每个页面底部添加编辑链接 |
| GitHub 编辑基础 URL | 用于构建链接的基础路径 |
开启编辑链接#
- 在登录状态下打开文档网站。
- 打开 Float Widget → 设计 → 内容选项卡。
- 开启显示“在 GitHub 上编辑”。
- 设置GitHub 编辑基础 URL — 请参阅下一节。
- 点击保存。
设置 GitHub 编辑基础 URL#
编辑基础 URL 告诉 Docsbook 将点击链接的读者发送到哪里。Docsbook 会将当前页面的路径附加到该 URL。
https://github.com/YOUR_USERNAME/YOUR_REPO/edit/YOUR_BRANCH/YOUR_DOCS_FOLDER选择与 Markdown 文件存放位置匹配的行：
| 仓库 | 文档位置 | 编辑基础 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 会根据你连接的仓库构建链接。
何时启用#
对于开源项目而言，编辑链接是你能提供的成本最低的贡献途径：读者可以在浏览器中修正错误的标志或过时的版本号，而你会收到一个拉取请求，而不是问题反馈。
对于内部团队文档而言，它让团队中的任何人都可以提出措辞修改建议，无需学习 Docsbook 界面——他们只需在 GitHub 上编辑文件，网站就会随之更新。
编辑链接不会调用任何 AI 模型，因此不会消耗你的项目余额。