mdbook-open-gh-issue

为 mdbook 添加“在 GitHub 上打开问题链接”的预处理器。

它会在每页底部添加一个“为此文件在 GitHub 上打开问题”的链接，直接链接到源文件。它使用配置的 git-repository-url 作为基础。

安装

如果您只想使用此预处理器，请安装工具

cargo install mdbook-open-gh-issue

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

[preprocessor.open-gh-issue]
command = "mdbook-open-gh-issue"
renderer = ["html"]

配置

mdbook-open-gh-issue 使用 [output.html] 下的附加选项进行配置

[output.html]
# Required: Your repository URL used in the link.
git-repository-url = "https://github.com/$user/$project"

# The text to use in the footer.
# The link text is marked by `[]`
gh-issue-text = "Outdated info? [Open issue on GitHub.]"

# The issue template to use. Defaults to "issue-template.yaml"
# New issue will get "file" parameter set to the current page.
gh-issue-template = "issue-template.yaml"

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

[output.html]
additional-css = ["gh-issue-open.css"]

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

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

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

最后，正常构建您的书籍

mdbook path/to/book

致谢

• mdbook-open-on-gh