mdbook-open-git-repo

mdbook 的预处理器，用于在每个页面上添加编辑链接。从 mdbook-open-on-gh 分支并适配，以支持除 github.com 之外的其他平台，如自托管的 GitLab 实例。

它在每个页面的底部添加一个可定制的链接（默认：“在 GitHub 上编辑此文件。”），直接链接到源文件。它使用配置的 git-repository-url 作为基础。

安装

使用 Cargo 安装或从发布页面获取二进制文件并将其放置在您的 $PATH 中。

将其添加为 book.toml 中的预处理器

[preprocessor.open-git-repo]
command = "mdbook-open-git-repo"
renderer = ["html"]

在 book.toml 中添加一个用作基础的仓库 URL

[output.html]
git-repository-url = "https://github.com/organization/repo"

托管在 github.com 或 gitlab.com 的仓库将自动检测。如果您使用的是例如自托管的 GitLab 实例，则必须指定主机类型

[preprocessor.open-git-repo]
source-control-host = "gitlab"

默认生成的内容如下

Found a bug? <a href="https://git.host.com/repo/project/branch/edit/chapter.md">Edit this file on GitHub.</a>

在 <a> 标签之前和内部的文本都可以自定义

[preprocessor.open-git-repo]
edit-text = "Something not right?"
link-text = "Fix it immediately!"

这将生成以下输出

Something not right? <a href="https://git.host.com/repo/project/branch/edit/chapter.md">Fix it immediately!</a>

要样式化页脚，请为您的 HTML 输出添加自定义 CSS 文件

[output.html]
additional-css = ["open-in.css"]

并在 open-in.css 中样式化 <footer> 元素或直接样式化 CSS 元素 id open-git-repo

footer {
  font-size: 0.8em;
  text-align: center;
  border-top: 1px solid black;
  padding: 5px 0;
}

此代码块缩小了文本大小，将其居中对齐在其余内容下方，并在文本上方添加一个水平条以将其与页面内容分开。

最后，按正常方式构建您的书籍

mdbook path/to/book

许可证

MPL。请参阅 LICENSE。
原始代码版权所有（c）2020 Jan-Erik Rediger [email protected].