mdbook-superimport

从其他文件导入代码/文本到您的 mdbook - 无链接失效问题。

背景/初始动机

mdbook-superimport 最初是 mdbook #879 中的一个问题。

当时，mdbook 中的默认 #include 预处理器仅支持通过指定行号导入文件的小部分内容 - 因此，如果您包括正在维护/更改的文件的一部分，您最终会忘记更新导入的行号，因为文件发生变化。

mdbook-superimport 允许您根据文件中的文本导入文件的一部分 - 因此，当您修改文件时，您将继续导入您期望的代码。

快速入门

cargo install mdbook-superimport

# In your book.toml
[preprocessor.superimport]

<!-- In your markdown files -->

{{#superimport ../path/to/file.foo@some-tag-name-here}}

// Some file named "file.foo"
fn main () {
  let not_imported = "This will NOT be imported!";

  // @superimport start some-tag-name-here

  // ...
  let imported = "This will be imported!"
  let also_imported = "Everyting between start/end gets imported."
  // ...

  // @superimport end some-tag-name-here
}

完整指南

mdbook-superimport 指南

API 文档

API

测试

./test.sh

另请参阅

• mdbook

许可证

Apache 2.0 / MIT