将你的书籍连接到代码仓库

你可以通过多种方式将书籍内容连接到公共仓库中的源文件。 以下我们介绍几种选项。

添加源仓库按钮

你可以使用一组按钮来链接到你的源仓库。这允许用户浏览仓库或执行诸如建议编辑或打开问题等操作。在每种情况下，它们都需要设置以下配置：

repository:
  url: https://github.com/{your-book-url}

添加仓库链接

要添加仓库链接，请添加以下配置：

repository:
  url: https://github.com/{your-book-url}
html:
  use_repository_button: true

添加打开问题按钮

要为当前页面添加一个打开问题的按钮，请使用以下配置：

repository:
  url: https://github.com/{your-book-url}
html:
  use_issues_button: true

添加建议编辑按钮

你可以在每个页面上添加一个按钮，允许用户直接编辑页面文本并提交拉取请求以更新文档。 要包含此按钮，请使用以下配置：

repository:
  url: https://github.com/{your-book-url}
  path_to_book: path/to/your/book  # 可选的书籍路径，默认为仓库根目录
  branch: yourbranch  # 可选的分支，默认为 `master`
html:
  use_edit_page_button: true