2025-03-14 21:59:59 -06:00
|
|
|
# tldr-lint
|
|
|
|
|
|
|
|
|
|
> Lint and format `tldr` pages.
|
2025-12-16 10:20:31 -07:00
|
|
|
> Note: `tldrl` can be used as an alias for `tldr-lint`.
|
|
|
|
|
> More information: <https://github.com/tldr-pages/tldr-lint#usage>.
|
2025-03-14 21:59:59 -06:00
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
- Lint a single page or all pages in a directory:
|
2025-03-14 21:59:59 -06:00
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`tldr-lint {{path/to/page_or_directory}}`
|
|
|
|
|
|
|
|
|
|
- Ignore specific `tldr-lint` error codes while linting:
|
|
|
|
|
|
|
|
|
|
`tldr-lint {{[-I|--ignore]}} {{TLDR001,TLDR002,...}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Format a specific page to `stdout`:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`tldr-lint {{[-f|--format]}} {{path/to/page.md}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
- Format a page in place:
|
2025-03-14 21:59:59 -06:00
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`tldr-lint {{[-f|--format]}} {{[-i|--in-place]}} {{path/to/page.md}}`
|
