TLDR Pages (стилизовано как tldr-pages ) — это бесплатный и открытый проект совместной документации программного обеспечения , который стремится стать более простым и доступным дополнением к традиционным man pages . Это коллекция поддерживаемых сообществом страниц справки, которые охватывают утилиты командной строки и другие компьютерные программы. Страницу можно вызвать, введя tldr команду . [2] [3] Название происходит от слова TL;DR , которое является аббревиатурой от «слишком длинный; не читал», имея в виду man pages , которые, по словам нескольких пользователей, слишком длинные. [4]
По состоянию на август 2024 года его репозиторий на GitHub имеет более 50 000 звезд и 4 100 форков. [5]
Ромен Прието начал проект, сделав первый коммит на популярном сайте хостинга кода и контроля версий GitHub 8 декабря 2013 года в 19:56:16 по часовому поясу своего персонального компьютера . [1]
Сначала в проект вносило свой вклад лишь несколько человек. К концу 2015 года, с помощью неизвестных китайских изданий, продвигающих его, проект стал стремительно набирать популярность на GitHub , оставив позади популярное программное обеспечение и языки программирования, такие как Swift . [6] 25 декабря 2015 года проект оказался на 3-м месте в тренде. [7] К 27 декабря 2015 года репозиторий достиг 2700+ звезд, набрав примерно 700 из них всего за неделю. [8] На следующий день проект попал на первую страницу Hacker News . [9] После публикации количество звезд, полученных проектом, достигло 3700+, а сам проект в течение дня занял первое место по ежедневной популярности. [10] [11] Проект пережил еще один скачок в конце 2017 года и позже сохранял стабильный рост популярности по сей день. [12]
По умолчанию для форматирования страниц tldr используется Markdown — популярный язык разметки, используемый во многих других проектах свободного программного обеспечения и документации. [13]
Хотя проект имеет собственное пользовательское {{token_syntax}}расширение, он придерживается спецификации CommonMark . Фактически спецификации проекта требуют, чтобы клиенты были полностью совместимы с CommonMark .
Получите типичные примеры использования команды:
команда tldr Чтобы увидеть, что можно сделать, вот довольно хорошая команда:
вкратце вкратцеПоказать страницу tar TLDR для Linux:
tldr -p линукс tarПолучить справку по подкоманде Git:
tldr git-checkoutОбновление локальных страниц (если клиент поддерживает кэширование):
tldr -uСтраницы TLDR можно писать в любом текстовом редакторе, поддерживающем форматирование CommonMark . [13]
Чтобы внести свой вклад в репозиторий tldr-pages на GitHub, вам необходимо подписать Лицензионное соглашение участника и следовать рекомендациям проекта, которые, как утверждается, представляют собой не строгие правила, а вспомогательную информацию для сохранения простоты страниц.
Страницы лицензированы в соответствии с лицензией Creative Commons Attribution 4.0 International , в то время как содержимое каталога scripts/лицензировано в соответствии с лицензией MIT . Любые вклады в проект регулируются лицензионным соглашением участника .
.svg/1280px-Free_and_open-source_software_logo_(2009).svg.png){kind=logo}