TLDR Pages (estilizado como tldr-pages ) es un proyecto de documentación de software colaborativo , gratuito y de código abierto que pretende ser un complemento más sencillo y accesible a las páginas man tradicionales . Es una colección de páginas de ayuda mantenidas por la comunidad que cubren utilidades de línea de comandos y otros programas informáticos. Se puede invocar una página mediante el comando . [ 2 ] [ 3 ] El nombre proviene de la palabra TL;DR , que es una abreviatura de "too long; didn't read" (demasiado largo; no lo leí), en referencia a las páginas man que varios usuarios consideran demasiado largas. [ 4 ]tldr
A julio de 2025, su repositorio en GitHub tiene más de 56.260 estrellas y 4.500 bifurcaciones. [ 5 ]
Historia
Romain Prieto inició el proyecto realizando la primera confirmación en el popular sitio de alojamiento de código y control de versiones GitHub , el 8 de diciembre de 2013 a las 19:56:16 según la zona horaria de su ordenador personal . [ 1 ]
Al principio, solo un puñado de personas contribuían al proyecto. A finales de 2015, con la ayuda de publicaciones chinas desconocidas que lo promocionaban, el proyecto experimentó un rápido crecimiento en popularidad en GitHub , dejando atrás a software y lenguajes de programación populares como Swift . [ 6 ] El 25 de diciembre de 2015, el proyecto terminó siendo tendencia en el tercer lugar. [ 7 ] Para el 27 de diciembre de 2015, el repositorio había alcanzado más de 2700 estrellas, habiendo ganado aproximadamente 700 de ellas solo en una semana. [ 8 ] Al día siguiente, el proyecto llegó a la página principal de Hacker News . [ 9 ] Después de la publicación, la cantidad de estrellas recibidas por el proyecto alcanzó más de 3700 y el proyecto mismo llegó al número 1 en popularidad diaria en el mismo día. [ 10 ] [ 11 ] El proyecto tuvo otro repunte a finales de 2017 y luego mantuvo un aumento estable de popularidad hasta el día de hoy. [ 12 ]
Formato
El formato predeterminado de tldr-pages es Markdown , un lenguaje de marcado popular utilizado en muchos otros proyectos de software libre y documentación. [ 13 ]
Si bien el proyecto cuenta con su propia {{token_syntax}}extensión personalizada, se adhiere a la especificación CommonMark . De hecho, las especificaciones del proyecto exigen que los clientes sean totalmente compatibles con CommonMark .
Uso de comandos
Obtén ejemplos de uso típicos de un comando:
comando tldrPara ver qué se puede hacer, un comando bastante útil sería:
Resumen Resumen Mostrar la página TLDR de tar para Linux:
tldr -p linux tar Obtén ayuda para un subcomando de Git:
tldr git-checkout Actualizar las páginas locales (si el cliente admite el almacenamiento en caché):
tldr -u Creación de contenido
Las páginas TLDR se pueden escribir en cualquier editor de texto que admita el formato CommonMark . [ 13 ]
Para contribuir al repositorio tldr-pages en GitHub, es necesario firmar el Acuerdo de Licencia de Colaborador y seguir las directrices del proyecto, que no son reglas estrictas, sino información auxiliar para mantener la sencillez de las páginas.
Licencias
Las páginas están bajo la licencia Creative Commons Atribución 4.0 Internacional , mientras que el contenido del scripts/directorio está bajo la licencia MIT . Cualquier contribución al proyecto se rige por el Acuerdo de Licencia para Colaboradores .
Véase también
Referencias
- 1 2 commit 11264d9b19000734a2d35ecbdbdebc0b0b45aed9
- ↑ "TLDR Pages: Páginas de manual simplificadas y creadas por la comunidad" . Noticias de Laravel .
- ↑ "TLDR - Páginas de manual fáciles de entender para todos los usuarios de Linux" . www.tecmint.com . 16 de enero de 2019.
- ↑ "Páginas TLDR: Páginas de manual simplificadas y creadas por la comunidad" . 22 de enero de 2020.
- ↑ /web/20210301121724/ https://github.com/tldr-pages/tldr
- ↑ "tldr-pages/tldr - Gitter" . gitter.im .
- ↑ "Monosnap" . monosnap.com .
- ↑ "tldr-pages/tldr - Gitter" . gitter.im .
- ↑ "Páginas TLDR | Hacker News" . news.ycombinator.com .
- ↑ "tldr-pages/tldr - Gitter" . gitter.im .
- ↑ @asyncadventures (28 de diciembre de 2015). "A veces, un pequeño proyecto paralelo es útil para otras personas y se vuelve tendencia :) ¡Gracias a todos los colaboradores de TLDR!" ( Tweet ) – vía Twitter .
- ↑ "Historia de las estrellas" . star-history.t9t.io . Archivado del original el 18 de febrero de 2021. Consultado el 13 de enero de 2022 .
- ^ " tldr-pages/tldr" . GitHub . 23 de noviembre de 2021.
Enlaces externos
- Sitio web oficial
- Repositorio
- Documentación en PDF
- Comunicación técnica