#mdbook #语法高亮 #预处理器 #插件

app mdbook-inline-highlighting

mdBook 预处理器,支持内联高亮显示

1个不稳定版本

0.1.0 2023年10月10日

#1898 in 文本处理

Download history 2/week @ 2024-05-20 37/week @ 2024-07-08 91/week @ 2024-07-15

每月128次下载

MIT 许可证

19KB
307 代码行

mdbook-inline-highlighting

安装

cargo install mdbook-inline-highlighting

使用

[preprocessors.inline-highlighting]

default-language = "js"
# Enforce JavaScript syntax highlighting when no language is specified. When this
# value is absent no syntax highlighting is applied unless explictly specified.

在您的章节之一中,您可以写入如下内容

This means you can use something like `[py] lambda x: x % 2 == 0` as an argument
for the `[none] accumulate` function. JavaScript has arrow functions which work
the same way. The equivalent would be `(x) => x % 2 == 0`.
  • [py] lambda x: x % 2 == 0 覆盖默认的 js
  • [none] accumulate 忽略默认的 js
  • (x) => x % 2 == 0 隐式使用默认的 js

注意,每个内联代码必须具有以下语法: [LANGUAGE] TEXT,空格是必需的。以反斜杠开头的内联代码将删除它,并保留其余部分,因此 \[py] if 将导致 [py] if.

此预处理器始终使用与代码块相同的版本的 highlight.js

演示

在克隆此仓库并安装crate后,导航到 test_book 目录,并运行 mdbook serve 以查看上面的示例。

依赖关系

~12–23MB
~324K SLoC