3 个不稳定版本
| 0.4.0-beta | 2023 年 1 月 27 日 |
|---|---|
| 0.4.0-alpha | 2023 年 1 月 25 日 |
| 0.3.0 | 2022 年 4 月 17 日 |
| 0.2.0-alpha |
|
| 0.1.1-alpha |
|
#1272 in 文本处理
80KB
2K SLoC
UnTeX
UnTeX 既是库也是可执行文件，允许您操作和理解 TeX 文件。
注意：虽然 TeX 和 LaTeX 不相同，但 UnTeX 假设 TeX 文档是以可由某些 LaTeX 引擎解析的方式编写的。对于 "纯" TeX 内容，请参阅
src/lib/tex模块。
可执行文件
使用 UnTeX 最方便的方式是通过其命令行界面 (CLI)。
目前，您可以使用 Cargo 安装它
cargo install untex --all-features
注意：虽然使用
--features cli已足以安装 UnTeX 的 CLI，但使用所有功能以获得最大好处是推荐的！
用法
UnTeX 有多个命令，每个命令都有特定的应用
-
check用于检查文档是否会无错误编译*； -
dependendies或deps，用于从 TeX 项目中提取依赖项； -
expand用于扩展宏（例如，\input{...}或\include{...}）； -
highlight或hl，用于突出显示 TeX 文档的部分（例如，注释）； -
format用于美化格式化您的 TeX 文件； -
parse用于解析和验证 TeX 文档*。 -
completions用于为您的 shell 生成补全脚本（需要"cli-complete"功能）。
untex <COMMAND> [OPTIONS] [FILENAMES]...
使用 untex [-h|--help] 或 untex <COMMAND> [-h|--help] 来获取某个命令的完整使用说明。
示例
文本高亮显示
untex hl -p math main.tex
echo "% this is a comment\nthis is not a comment" | untex hl -t comment
库
您可以在Rust项目中通过添加到您的 Cargo.toml 来使用UnTeX。
untex = "^0.4.0"
文档
自动生成的文档可以在这里找到。
功能标志
默认功能
-
color：通过
termcolor支持在终端中输出彩色文本。 -
strum：使用
strum_macros的功能增强库中的所有Enum。
可选功能
-
cli：为多个结构添加与命令行相关的功能。此功能是安装UnTeX CLI所必需的。
-
annotate：（即将推出）为检查请求的结果添加方法。如果启用 cli 功能，CLI将默认打印注释输出。
-
cli-complete：为各种shell生成完成文件。此功能还激活了 cli 功能。输入
untex completions --help获取安装完成文件的说明。 -
json：（即将推出）添加
json输出选项。
免责声明
由于本项目正在积极开发中，因此不同版本之间可能存在不兼容的更改。在达到 v1.x.x 之前，UnTeX 将被视为不稳定。
什么是有效的 (La)TeX 文档
解析 La(TeX) 文档非常复杂，主要原因是详细说明在文档的标题中。因此，UnTeX 并不旨在成为一个精确的解析器，而是一个相对较好的解析器。
如果您认为UnTeX产生了错误的结果，请通过 GitHub issue 联系我，最好解释一下您期望的结果！
贡献
欢迎贡献！让UnTeX成为一个好且可靠的TeX工具需要时间和工作，所以任何类型的帮助都是朝着更好的UnTeX迈进的一步！
依赖关系
~2–12MB
~106K SLoC