1 个不稳定版本
0.1.0 | 2021 年 5 月 30 日 |
---|
#23 in #anchor
17KB
198 行(不含注释)
mdbook-chapter-path
基于名称提供章节路径的 mdBook 预处理器。
入门
首先,安装 mdbook-chapter-path
crate
cargo install mdbook-chapter-path
然后,将以下行添加到您的 book.toml
文件中
[preprocessor.chapter-path]
完成后,您现在可以使用 {{#path_for $NAME_OF_CHAPTER}}
来插入该章节的路径(相对于 SUMMARY.md
)。
例如,如果您有一个名为 "Whatever" 的章节,位于 "foo/whatever.md",则 markdown {{#path_for Whatever}}
将替换为 /foo/whatever.md
。
这对于锚点链接也有效,例如 {{#path_for Whatever#an_anchor}}
将替换为 /foo/whatever.md#an_anchor
。
这很有用,因为它意味着链接将能够存活文件移动。
配置
mdbook-chapter-path
将使用在 output.html.site-url
中列出的内容作为所有链接的基本路径,默认为 '/'。
此外,您还可以启用 strict
模式。如果设置为 true
,则 mdbook-chapter-path
将在遇到重复的章节名称时退出并显示错误。默认为 false
,这意味着允许重复的章节名称。
⚠️ 如果未启用严格模式,如果您有多个具有相同名称(不区分大小写)的章节,则 mdbook-chapter-path
将提供在书中列出的最后一个章节的路径。
[preprocessor.chapter-path]
strict = true
依赖项
~12–23MB
~324K SLoC