#mdbook #preprocessor #code-block

app mdbook-codeblocks

A mdbook 预处理器,用于在代码块前添加自定义的摘要

14 个版本

0.1.15 2024 年 5 月 21 日
0.1.14 2024 年 3 月 16 日
0.1.12 2023 年 12 月 6 日
0.1.11 2023 年 10 月 7 日
0.1.4 2023 年 4 月 24 日

#502文本处理

Download history 138/week @ 2024-05-18 8/week @ 2024-05-25 2/week @ 2024-06-08 1/week @ 2024-06-15 61/week @ 2024-06-29 3/week @ 2024-07-13 72/week @ 2024-07-27

每月 75 次下载

MIT/Apache

25KB
387

mdbook-codeblocks

build crates.io

一个为 mdbook 预处理器的预处理器,用于在代码块上方添加摘要。

用法

首先,您需要运行以下命令安装预处理器。

cargo install mdbook-codeblocks

然后,您需要将预处理器添加到您的 book.toml 文件中。自定义功能尚处于早期阶段,但您已经可以定义语言的自定义 图标标签颜色链接

[book]
authors = ["Roms1383"]
title = "Code blocks preprocessor example"

[output.html]

[preprocessor.codeblocks]
renderers = ["html"]
cpp = { color = "#FFFF99", link = "https://wiki.redmodding.org/red4ext" }
redscript = { color = "tomato", link = "https://wiki.redmodding.org/redscript" }
rust = { color = "#ac4313", link = "https://github.com/jac3km4/red4ext-rs" }
lua = { link = "https://wiki.redmodding.org/cyber-engine-tweaks" }
swift = { label = "Swift code snippet", color = "skyblue" }

它将产生以下内容

example

您实际上可以在 示例 文件夹中找到它。

⚠️ 同时,不要忘记嵌入 FontAwesome css,请参阅 示例/主题/头部.hbs

路线图

这个工具非常基础,但欢迎贡献!

特别是 HTML/CSS :)

同样,它目前只支持 5 种语言的小子集,请添加更多!

归属

此工具默认使用 FontAwesome 的图标。

依赖项

~12–23MB
~327K SLoC