TLDR Pages
 | |
 Screenshot of tldr-pages in action | |
| Original author(s) | Romain Prieto |
|---|---|
| Initial release | December 8, 2013[1] |
| Repository | github |
| Written in | Markdown |
| Platform | Multiplatform |
| Available in | German, Spanish, Farsi, French, Indonesian, Italian, Japan, Korean, Malayalam, Dutch, Norwegian, Portugal, Russian, Swedish, Slovene, Hindi, Tamil, Thai, Turkish, Chinese |
| Type | Software documentation |
| License | CC BY-SA 4.0 MIT License |
| Website | tldr |
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 covers 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 March 2021, its repository on GitHub has 30,000 stars and 2,500 forks.[5]
History
Romain Prieto started the project by making the first commit on the famous code hosting and version controlling site GitHub, on 8 December 2013 at 19:56:16 according to the timezone of their personal computer.[6]
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 in behind.[7] On 25 December 2015, the project ended up trending at 3rd place.[8] By 27 December 2015, the repository had reached 2700+ stars, having gained approximately 700 of it only in a week.[9] In the following day, the project reached to the front page of Hacker News.[10] 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.[11][12] The project had seen another bump in late 2017 and later kept a stable increase of popularity to this day.[13]
Formatting
The default formatting usage of tldr-pages is Markdown, a popular markup language used in many other free software and documentation projects.[14]
While the project has its own custom {{token_syntax}} extension, it adheres to CommonMark specification. In fact the project specifications require that clients are fully compatible with the CommonMark.
Command usage
Get typical usages of a command:
tldr command
Show the tar TLDR page for Linux:
tldr -p linux tar
Get help for a Git subcommand:
tldr git-checkout
Update local pages (if the client supports caching):
tldr -u
See also
References
- ^ commit 11264d9b19000734a2d35ecbdbdebc0b0b45aed9
- ^ https://laravel-news.com/tldr-pages
- ^ https://www.tecmint.com/tldr-easy-to-understand-linux-man-pages/
- ^ https://www.reddit.com/r/linux/comments/ese2dt/tldr_pages_simplified_communitydriven_man_pages/
- ^ /web/20210301121724/https://github.com/tldr-pages/tldr
- ^ commit 11264d9b19000734a2d35ecbdbdebc0b0b45aed9
- ^ https://gitter.im/tldr-pages/tldr/archives/2015/12/25
- ^ https://monosnap.com/file/LjjQCt1n5EP0iuY7l199ysrgHlAkuG
- ^ https://gitter.im/tldr-pages/tldr/archives/2015/12/27?at=56806f6b653b30761d7644c9
- ^ https://news.ycombinator.com/item?id=10797303
- ^ https://gitter.im/tldr-pages/tldr/archives/2015/12/28?at=5681c31f35e1a316162e7b62
- ^ https://twitter.com/asyncadventures/status/681594304108756992
- ^ https://web.archive.org/web/20210218080438/https://star-history.t9t.io/
- ^ https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md
External links
| General | |||
|---|---|---|---|
| Software packages | |||
| Community | |||
| Organisations | |||
| Licenses |
| ||
| Challenges | |||
| Related topics | |||
