Some pre-commit hooks for docs.
.pre-commit-config.yaml
repos:
- repo: https://github.com/PFCCLab/dochooks
rev: v0.6.0
hooks:
- id: check-whitespace-between-cn-and-en-char
files: \.md$|\.rst$
- id: insert-whitespace-between-cn-and-en-char
files: \.md$|\.rst$
- id: check-case-conflict
用于检查中英文之间是否有空格
用于自动在中英文之间添加空格
用于检测在大小写不敏感文件系统(如 APFS、NTFS)上可能冲突的文件名例如仓库中已有 file.txt
,新建 File.txt
时会发现冲突。
自定义错误信息:
- id: check-case-conflict
args: ['--error-message="错误:检测到大小写冲突!\n{conflicts}"']
dochooks 支持 dochooks: skip-next-line
和 dochooks: skip-line
两种 pragma
<!-- dochooks: skip-next-line -->
这是一段中文and English混合的text
这是一段中文and English混合的text <!-- dochooks: skip-line -->