mdbook-section-validator

入门指南

首先，安装 mdbook-section-validator 包

cargo install mdbook-section-validator

然后，将以下行添加到您的 book.toml 文件中

[preprocessor.section-validator]

最后，添加一些自定义 CSS 样式来控制部分验证的工作方式，我在 personal-knowledge 中使用以下样式

.validated-content {
    background-color: var(--quote-bg);
    border: 1px solid var(--quote-border);
    padding: 0 16px;
}

完成以上步骤后，您现在可以在行的开头使用 !!! 来定义仅在链接的问题仍然有效的情况下包含的部分。

在 !!! 开始条件包含后，您必须包含一个逗号分隔的票务 URL 列表。如果所有链接的问题仍然打开，则该部分中的 Markdown 将被包含。该部分将被删除，或前面加上一个说明，说明该部分已过时。

# Chapter 1

!!!https://github.com/younata/mdbook-section-validator/issues/1,https://github.com/younata/mdbook-section-validator/issues/2

This is only rendered while issues 1 and 2 of younata/mdbook-section-validator are open. If 1 is closed, but not 2, then this is removed the next time mdbook renders. 
!!!

This is always rendered.

内部内容将在运行 mdbook build 或 mdbook serve 时按常规方式渲染为 Markdown。

配置

如前所述，默认情况下会删除不再有效的部分。您可以通过重写 hide_invalid 为 false 来配置它。您可以通过设置 invalid_message 为任何字符串来配置要显示的消息。它将被渲染为 Markdown。

[preprocessor.section-validator]
hide_invalid = false
invalid_message = "Warning, this content is out of date and is included for historical reasons."