| tldr-pages | |
| Author: | Romain Prieto |
| Released: | [1] |
| Programming Language: | Markdown |
| Platform: | Multiplatform |
| Language: | German, Spanish, Farsi, French, Indonesian, Italian, Japan, Korean, Malayalam, Dutch, Norwegian, Portugal, Russian, Swedish, Slovene, Hindi, Tamil, Thai, Turkish, Chinese,Ukrainian, Arabic, Bengali, Bosnian, Catalan, Persian |
| Genre: | Software documentation |
| License: | CC BY-SA 4.0 MIT License |
TLDR Pages (stylized as tldr-pages) is a free and open-source collaborative software documentation project that aims to be a simpler, more approachable complement to traditional man pages. It's a collection of community-maintained help pages that cover command-line utilities and other computer programs. A page can be invoked by issuing the tldr command.[2] [3] The name comes from the word TL;DR, which is an abbreviation for "too long; didn't read", referring to man pages that are said to be too long by several users.[4]
As of August 2024, its repository on GitHub has more than 50,000 stars and 4,100 forks.[5]
Romain Prieto started the project by making the first commit on the popular code hosting and version control site GitHub, on 8 December 2013 at 19:56:16 according to the timezone of his personal computer.[1]
At first, only a handful of people were contributing to the project. By the end of 2015, with the help of unknown Chinese publications promoting it, the project has seen a rapid amount of growth in popularity on GitHub, leaving popular software and programming languages like Swift behind.[6] On 25 December 2015, the project ended up trending at 3rd place.[7] By 27 December 2015, the repository had reached 2700+ stars, having gained approximately 700 of it only in a week.[8] On the following day, the project reached the front page of Hacker News.[9] After the post, the amount of stars received by the project reached to 3700+ and the project itself arrived at #1 in daily popularity within the day.[10] [11] The project had seen another bump in late 2017 and later kept a stable increase of popularity to this day.[12]
The default formatting usage of tldr-pages is Markdown, a popular markup language used in many other free software and documentation projects.[13]
While the project has its own custom <nowiki>{{token_syntax}}</nowiki> extension, it adheres to CommonMark specification. In fact the project specifications require that clients are fully compatible with CommonMark.
Get typical usages of a command:
To see what can be done, a reasonably nice command would be:
Show the tar TLDR page for Linux:
Get help for a Git subcommand:
Update local pages (if the client supports caching):
TLDR Pages can be written in any text editor that supports CommonMark formatting.[13]
To make a contribution to the tldr-pages repository on GitHub, you need to sign the Contributor License Agreement and follow the project's guidelines, which are said to be not strict rules but auxiliary information to keep the simple nature of the pages.
The pages are licensed under the Creative Commons Attribution 4.0 International License, while the contents of the scripts/ directory are licensed under MIT License. Any contributions to the project are governed under the Contributor License Agreement.