gokhlayeh/textidote

TeXtidote

轻量级https://github.com/sylvainhalle/textidote%E9%95%9C%E5%83%8F%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%AF%B9TeX%E6%96%87%E6%A1%A3%E8%BF%9B%E8%A1%8C%E4%BB%A3%E7%A0%81%E6%A3%80%E6%9F%A5%E3%80%81%E6%8B%BC%E5%86%99%E5%92%8C%E8%AF%AD%E6%B3%95%E6%A3%80%E6%9F%A5%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E5%B7%B2%E7%94%A8%E4%BA%8Ehttps://github.com/ChiefGokhlayeh/textidote-action%EF%BC%88%E4%B8%80%E4%B8%AA%E4%BB%A5CI/CD%E6%96%B9%E5%BC%8F%E6%A3%80%E6%9F%A5TeX%E6%96%87%E6%A1%A3%E7%9A%84GitHub Action），同时也可在GitHub Action之外的场景中通用。

核心功能和特性

• 对TeX/LaTeX文档进行代码规范性检查
• 提供拼写和语法错误检测
• 支持多种报告格式输出（如singleline、html）
• 可通过阈值设置控制错误退出码
• 支持自定义检查参数

使用场景

• TeX/LaTeX文档的本地开发检查
• CI/CD流程中集成TeX文档质量检查
• 学术论文、技术文档的拼写和语法校对

使用方法

基本命令格式

sh
docker run -it -v '/path/to/workspace:/textidote' gokhlayeh/textidote ROOT_FILE WORKING_DIR REPORT_TYPE REPORT_FILE THRESHOLD_ERROR [ARGS...]

参数说明

ROOT_FILE** 必选 **- 要检查的根LaTeX文件路径。

WORKING_DIR** 必选 **- 容器内执行TeXtidote的工作目录。如无需指定，传递空字符串，示例：""。

REPORT_TYPE** 可选 **- TeXtidote报告类型（对应TeXtidote的--output选项）。示例：singleline、html。

REPORT_FILE** 可选 **- 报告文件路径。若省略或为空，报告将输出到终端。

THRESHOLD_ERROR** 可选 **- 警告数量阈值，超过此值将返回非零退出码。

ARGS** 可选 **- 传递给TeXtidote的额外参数。所有参数需放在一个引号块中，示例：'--quiet --check en --dict en.dict'。

使用示例

生成singleline格式报告

将当前目录下的doc目录挂载到容器，检查main.tex并生成singleline格式报告：

sh
docker run -it --rm -v "$(pwd)/doc:/doc" gokhlayeh/textidote "main.tex" "/doc" singleline

生成HTML格式报告到文件

将检查结果以HTML格式写入挂载目录下的report.html：

sh
docker run -it --rm -v "$(pwd)/doc:/doc" gokhlayeh/textidote "main.tex" "/doc" html 'report.html'

使用英文拼写检查器

指定使用英文（en）拼写检查器：

sh
docker run -it --rm -v "$(pwd)/doc:/doc" gokhlayeh/textidote "main.tex" "/doc" '' '' '' '--check en'

提示与技巧

若默认entrypoint.sh的语法限制了使用需求，可通过docker run ... --entrypoint ...覆盖默认入口点。

容器内可通过/usr/local/bin/textidote直接执行TeXtidote，这是一个调用位于/usr/local/share/java/textidote/textidote.jar的shell脚本。