#mdbook #widgets #interactive #directory #file #renders #book

bin+lib mdbook-files

mdbook 预处理器,将目录中的文件渲染为交互式小部件

2 个不稳定版本

0.2.0 2023年12月29日
0.1.0 2023年12月16日

#1298 in 文本处理

MIT 许可证

310KB
404

mdbook-files

docs.rs status Crates.io version

mdBook 预处理器,将目录中的文件渲染为带有语法高亮的交互式小部件

Example of mdbook-files

示例

您可以通过在此存储库的示例目录中启动 mdbook 来运行示例。

mdbook serve

用法

使用 cargo 安装 mdbook-files

cargo install mdbook-files

将以下内容放入您的 book.toml

[preprocessor.files]
prefix = "examples"

前缀是一个路径,相对于该路径包含文件。必须提供前缀。本书中的每个包含路径都必须在此前缀内。

您还需要将此存储库中的 style.css 添加到您的额外 CSS 文件列表中

[output.html]
additional-css = ["style.css"]

要使用它,请将以下内容添加到您的书中

```files
title = "Files in subfolder"
paths = ["subfolder/**"]
```

这将生成一个具有给定标题的、包含 examples/subfolder 中所有文件的控件。此内容是一个包含配置的 TOML 文档。

许可证

MIT。

依赖关系

~15–27MB
~389K SLoC