mdbook-private

一个用于定义并可选隐藏书籍中私有章节和部分的 mdbook 预处理器。

用法

安装

cargo install mdbook-private

在 book.toml 中的配置

# Default options
[preprocessor.private]
remove = false
style = true
notice = "CONFIDENTIAL"
chapter-prefix = "_"

选项说明

• remove (布尔值): 确定是否删除或保留标记为私有的部分。
• style (布尔值): 使用块引用 CSS 样式私有部分（当保留时）。
• notice (字符串): 在样式化部分的右上角添加通知。
• chapter-prefix (字符串): 如果 remove 选项激活，则具有此值前缀的章节将被排除。

Markdown 用法

为了实际操作，请探索 example-book。

# Summary

- [Chapter 1](./chapter_1.md)
  - [Sub chapter](./_chapter_1_sub.md)
- [Chapter 2](./_chapter_2.md)
  - [Sub chapter](./chapter_2_sub.md)

注意：启用 remove 选项后，仅保留 "第一章"。

<!--private
This is some highly confidential material which we want to hide when sharing with external parties.

Another *line*.

# A title that should remain a title  
Yet another **line**.
-->