Страницы TLDR
 | |
 Скриншот CLI- клиента для tldr-страниц | |
| Оригинальный автор(ы) | Ромен Прието |
|---|---|
| Первоначальный выпуск | 8 декабря 2013 г [ 1 ] |
| Репозиторий | github |
| Написано в | Уценка |
| Платформа | Мультиплатформенность |
| Доступно в | Немецкий , испанский , фарси , французский , индонезийский , итальянский , японский , корейский , малаялам , голландский , португальский , норвежский , русский , шведский , словенский , хинди , тамильский , тайский , турецкий , китайский , украинский , арабский , бенгальский боснийский , , каталанский , персидский |
| Тип | Документация по программному обеспечению |
| Лицензия | CC BY-SA 4.0 МОЯ лицензия |
| Веб-сайт | TLDR |
TLDR Pages (стилизованный под tldr-pages ) — это с открытым исходным кодом для совместной работы бесплатный проект документации программного обеспечения , цель которого — стать более простым и доступным дополнением к традиционным man-страницам . Это коллекция поддерживаемых сообществом справочных страниц, на которых описаны утилиты командной строки и другие компьютерные программы. Страницу можно вызвать, выполнив команду tldr команда . [ 2 ] [ 3 ] Название происходит от слова TL;DR , которое является аббревиатурой от «слишком долго; не читал», что относится к справочным страницам , которые некоторые пользователи считают слишком длинными. [ 4 ]
По состоянию на июль 2024 года его репозиторий на GitHub насчитывает более 49 600 звезд и 4100 форков. [ 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 command
Чтобы увидеть, что можно сделать, достаточно хорошей командой будет:
tldr tldr
Показать страницу tar TLDR для Linux:
tldr -p linux tar
Получите справку по подкоманде Git:
tldr git-checkout
Обновите локальные страницы (если клиент поддерживает кеширование):
tldr -u
Авторская работа
[ редактировать ]Страницы TLDR можно создавать в любом текстовом редакторе, поддерживающем форматирование CommonMark . [ 13 ]
Чтобы внести свой вклад в репозиторий tldr-pages на GitHub, вам необходимо подписать Лицензионное соглашение участника и следовать рекомендациям проекта, которые, как утверждается, представляют собой не строгие правила, а вспомогательную информацию, позволяющую сохранить простой характер страниц.
Лицензирование
[ редактировать ]Страницы доступны под лицензией Creative Commons Attribution 4.0 International License , а содержание scripts/ каталог лицензируются по лицензии MIT . Любое участие в проекте регулируется Лицензионным соглашением для участников .
См. также
[ редактировать ]
Ссылки
[ редактировать ]- ^ Перейти обратно: а б зафиксировать 11264d9b19000734a2d35ecbdbdebc0b0b45aed9
- ^ «Страницы TLDR: упрощенные и управляемые сообществом справочные страницы» . Новости Ларавел .
- ^ «TLDR — понятные страницы руководства для каждого пользователя Linux» . www.tecmint.com . 16 января 2019 г.
- ^ «Страницы TLDR: упрощенные справочные страницы, управляемые сообществом» . 22 января 2020 г.
- ^ /web/20210301121724/ https://github.com/tldr-pages/tldr
- ^ «tldr-pages/tldr — Gitter» . gitter.im .
- ^ «Моноснап» . monosnap.com .
- ^ «tldr-pages/tldr — Gitter» . gitter.im .
- ^ «Страницы TLDR | Хакерские новости» . news.ycombinator.com .
- ^ «tldr-pages/tldr — Gitter» . gitter.im .
- ^ @asyncadventures (28 декабря 2015 г.). «Иногда небольшой побочный проект полезен другим людям и становится популярным :) Спасибо всем участникам TLDR!» ( Твит ) – через Твиттер .
- ^ «Звездная история» . star-history.t9t.io . Архивировано из оригинала 18 февраля 2021 года . Проверено 13 января 2022 г.
- ^ Перейти обратно: а б "tldr-pages/tldr" . Гитхаб . 23 ноября 2021 г.
