TLDR-sidor

tldr-sidor
	Skärmdump av tldr-sidor i aktion
Originalförfattare	Romain Prieto
Initial release	8 december 2013 ; för 9 år sedan
Förvar	github .com /tldr-pages /tldr
Skrivet i	Prissänkning
Plattform	Multiplattform
Tillgänglig i	tyska , spanska , farsi , franska , indonesiska , italienska , Japan , koreanska , malayalam , holländska , norska , portugal , ryska , svenska , slovenska , hindi , tamilska , thailändska , turkiska , kinesiska , ukrainska , arabiska , bengali , bosniska , katalanska , persiska
Typ	Programvarudokumentation
Licens	; CC BY-SA 4.0 MIT-licens
Hemsida	tldr .sh

TLDR Pages (stiliserad som tldr-pages ) är ett gratis och öppen källkodssamarbetande programvarudokumentationsprojekt som syftar till att vara ett enklare och mer lättillgängligt komplement till traditionella man-sidor . Det är en samling av community-underhållna hjälpsidor som täcker kommandoradsverktyg och andra datorprogram. En sida kan anropas genom att utfärda kommandot tldr . Namnet kommer från ordet TL;DR , som är en förkortning för "för lång; läste inte", syftar på man-sidor som sägs vara för långa av flera användare.

Från och med december 2022 har dess arkiv på GitHub mer än 41 000 stjärnor och 3 500 gafflar.

Historia

Romain Prieto startade projektet genom att göra det första åtagandet på den berömda kodvärd- och versionskontrollsajten GitHub , den 8 december 2013 kl. 19:56:16 enligt tidszonen för deras persondator .

Till en början var det bara en handfull personer som bidrog till projektet. I slutet av 2015, med hjälp av okända kinesiska publikationer som marknadsför det, har projektet sett en snabb ökning i popularitet på GitHub , vilket lämnar populär programvara och programmeringsspråk som Swift bakom sig. Den 25 december 2015 hamnade projektet på en 3:e plats. Den 27 december 2015 hade förvaret nått 2700+ stjärnor, efter att ha fått cirka 700 av det bara på en vecka. Följande dag nådde projektet framsidan av Hacker News . Efter inlägget nådde antalet stjärnor som projektet fick till 3700+ och själva projektet nådde #1 i daglig popularitet under dagen. Projektet hade sett ytterligare en stöt i slutet av 2017 och höll senare en stabil ökning av popularitet till denna dag.

Formatering

Standardformateringsanvändningen för tldr-pages är Markdown , ett populärt märkningsspråk som används i många andra gratisprogram och dokumentationsprojekt.

Även om projektet har sitt eget anpassade {{token_syntax}}- tillägg, följer det CommonMark- specifikationen. Faktum är att projektspecifikationerna kräver att kunderna är helt kompatibla med CommonMark .

Kommandoanvändning

Få typiska användningsområden för ett kommando:

 tldr  kommando

För att se vad som kan göras skulle ett ganska trevligt kommando vara:

tldr tldr

Visa tar TLDR-sidan för Linux:

tldr -p linux tar

Få hjälp för ett Git-underkommando:

tldr git-checkout

Uppdatera lokala sidor (om klienten stöder cachning):

tldr -u

Författarskap

TLDR-sidor kan skrivas i vilken textredigerare som helst som stöder CommonMark- formatering.

För att göra ett bidrag till tldr-pages repository på GitHub måste du underteckna Contributor License Agreement och följa projektets riktlinjer, som sägs inte vara strikta regler utan hjälpinformation för att hålla sidornas enkla karaktär.

Licensiering

Sidorna är licensierade under Creative Commons Attribution 4.0 International License , medan innehållet i skripten/ katalogen är licensierat under MIT License . Alla bidrag till projektet regleras av Contributor License Agreement .

Se även

externa länkar