Linux command
tldr-lint 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Lint file
tldr-lint [page.md]
Lint directory
tldr-lint [pages/]
Verbose output
tldr-lint -v [page.md]
Format output
tldr-lint -f [json] [page.md]
Ignore rules
tldr-lint -I [TLDR001] [page.md]
说明
tldr-lint validates TLDR pages against the project's formatting guidelines, checking for structural correctness, proper markdown syntax, and style compliance. Each rule is identified by a code (e.g., TLDR001) and can be selectively ignored with the -I flag. The tool can lint individual files or scan entire directories for batch validation, making it suitable for CI pipelines that enforce consistent page formatting across the tldr-pages repository. Output formats include plain text and JSON for integration with other tools.
参数
- -v
- Verbose output.
- -f _FORMAT_
- Output format.
- -I _RULES_
- Ignore rules.
- --version
- Show version.
- --help
- Show help.
FAQ
What is the tldr-lint command used for?
tldr-lint validates TLDR pages against the project's formatting guidelines, checking for structural correctness, proper markdown syntax, and style compliance. Each rule is identified by a code (e.g., TLDR001) and can be selectively ignored with the -I flag. The tool can lint individual files or scan entire directories for batch validation, making it suitable for CI pipelines that enforce consistent page formatting across the tldr-pages repository. Output formats include plain text and JSON for integration with other tools.
How do I run a basic tldr-lint example?
Run `tldr-lint [page.md]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does -v do in tldr-lint?
Verbose output.