Pandoc 的 Lua 过滤器项目指南

Pandoc 的 Lua 过滤器项目指南

lua-filtersA collection of lua filters for pandoc项目地址:https://gitcode.com/gh_mirrors/lu/lua-filters

目录结构及介绍

在克隆或下载了 pandoc/lua-filters 仓库后，你可以看到以下主要的文件和目录：

• filters/: 此目录包含所有可用的 Lua 过滤器。每个过滤器都有其特定的功能，例如调整表格布局、修正拼写错误等。

• Makefile: 构建系统定义如何编译和测试过滤器。

• README.md: 介绍了这个项目的总体信息和如何使用 Lua 过滤器来扩展 Pandoc 功能。

• runtests.sh: 测试脚本用于验证过滤器是否正常工作。

• LICENSE: 声明了此项目采用 MIT 许可证。

• CONTRIBUTING.md: 提供关于如何贡献代码和参与项目维护的信息。

• editorconfig 和 gitignore: 分别包含了代码风格规范和 Git 忽略规则。

启动文件介绍

由于 Lua 过滤器本质上是作为 Pandoc 命令行工具的插件使用的，因此没有传统意义上的“启动”过程。当你希望应用一个过滤器时，你可以在 Pandoc 的命令中添加 -L 或 --lua-filter 参数来指定要加载的 Lua 脚本的位置。例如：

pandoc input.txt -o output.html --lua-filter=path/to/filter.lua

在这个例子中，path/to/filter.lua 就是你从 filters/ 目录选择的一个 Lua 过滤器的路径。

配置文件介绍

由于 Lua 过滤器通常不需要独立的配置文件，它们通过 Lua 代码中的参数进行定制。然而，可以通过环境变量或在运行 Pandoc 命令时传递特殊选项来控制某些行为。比如，某些过滤器可能依赖于外部程序，这些程序的安装位置或版本可能会影响过滤器的行为，这往往需要在执行命令前进行适当的设置。

另外，在 Pandoc 中使用过滤器时可以提供额外的数据给 Lua 脚本来实现更复杂的功能。具体到某个过滤器的具体配置项和用途，你需要查看相应的 Lua 文件内的注释和说明。

为了方便全局使用过滤器而无需每次指定完整路径，可以将过滤器置于 Pandoc 用户数据目录下的 filters 子目录内。这样就可以仅使用过滤器名称（即.lua文件名）调用它们：

pandoc input.txt -o output.html --lua-filter=my_filter

其中 my_filter 应当是在用户数据目录下对应的 .lua 文件名。

lua-filtersA collection of lua filters for pandoc项目地址:https://gitcode.com/gh_mirrors/lu/lua-filters