tldr-lint

Lint all pages

$ tldr-lint [pages_directory]

$ tldr-lint --format [page.md]

$ tldr-lint --format --in-place [pages_directory]

tldr-lint [options] [file...]

--help
    Show help message and exit.

--version
    Show program's version number and exit.

file...
    One or more tldr page files to lint.

tldr-lint is a command-line tool designed to validate the syntax and style of tldr pages. tldr pages are community-driven simplified and community maintained man pages.

tldr-lint helps maintain the quality and consistency of these pages by checking for common errors, enforcing style guidelines, and ensuring adherence to the tldr project's specifications. It automates checks for various aspects of the tldr page format, such as proper usage of code blocks, placeholders, links, and general formatting, significantly reducing the need for manual reviews and improving the overall readability and usability of tldr documentation.

The tldr-lint command exits with a status code of 0 if no errors are found. A non-zero exit status indicates that one or more errors were detected in the tldr page(s).

tldr-lint was created to support the tldr project's mission to provide concise, community-driven help pages for command-line tools. As the tldr project grew, the need for an automated tool to ensure consistency and quality across all contributed pages became apparent. tldr-lint emerged as a solution to streamline the review process, allowing contributors to quickly identify and correct formatting errors before submitting changes. It is actively maintained and updated as the tldr project's guidelines evolve.

tldr(1)