Сделай динамически обновляемую статистику в своем README!
Посмотреть демо · Сообщить об ошибке · Предложить функцию · FAQ · Задать вопрос
Deutsch · English · Español · Français · Italiano · Nederlands · Português Brasileiro · Türkçe · Русский · Український · नेपाली · 日本語 · 简体中文 · 한국어
[!IMPORTANT]\
Обратите внимание, что переводы могут быть устаревшими, постарайтесь по возможности использовать английскую версию
Перевод выполнен senymama и может содержать ошибки и быть устаревшим (дату последнего обновления можно узнать в информации о последнем коммите этого фйла). В этом случае отправляйте issues в мой форк репозитория, поскольку авторы не имеют отношения к этому переводу.
Также мой перевод может немного отличается от оригинальной документации, потому что в некоторых моментах авторская документация мне показалось недостаточно наглядной. (Например я добавил пример баннера после описания каждого параметра, и все примеры теперь в теге <details>, чтобы документация занимала меньше места и была более читаемой)
P.s. (Это я пишу уже после завершения перевода)
Перевести 1000 строк markdown кода на русский у меня заняло около 6 часов, и не меньше займет перевод на украинский.
Если вы хотите поддержать мои старания и замотивировать продолжать поддерживать эту документацию вы можете:
- Посмотреть мои другие репозитории и поставить звезду на те, которые вам покажутся интересными
Возможно я добавлю дополнительные способы поддержать меня, но пока мне хватит активности на моем профиле, это действительно очень замотивирует меня как продолжать этот проект, так и делать новые и делать их более качественно.
- Перевод
- GitHub Stats Card (баннер статистики)
- GitHub Extra Pins (Добавочные закрепы)
- GitHub Gist Pins (Закрепы gits'ов)
- Top Languages Card (Баннер самых используемые языков)
- Баннер статистики WakaTime
- Кастомизация
- All Demos
- Развертывание собственного экземпляра
- 💖 Поддержать проект
Important
Поскольку GitHub API разрешает только 5 тысяч запросов в час для одной учетной записи, общедоступный Vercel, размещенный на https://github-readme-stats.vercel.app/api может достичь ограничения (см. #1471). Чтобы это избежать мы используем кэширование (см. https://github.com/anuraghazra/github-readme-stats#common-options). Вы можете избежать ограничения, развернув свой собственный экземпляр Vercel.
Important
Мы маленькая команда, поэтому при расстановки приоритетов задач мы полагаемся на голоса 👍. Мы используем "Top Issues dashboard" для отслеживания спроса комьюнити (см. #1935). Голосуйте за за интересующие вас issues и pull request. В первую очередь мы будет работать над самыми популярными вопросами.
Скопируйте и вставьте это в свой markdown файл, и все. Да, так просто!
Замените значение ?username= на свой GitHub username.
[](https://github.com/anuraghazra/github-readme-stats)👀 Простейший пример
Warning
По умолчанию на карточке статистики отображаются только такие статистические данные, как звезды, коммиты и запросы на включение из общедоступных репозиториев. Чтобы отобразить личную статистику на карточке статистики, вам следует развернуть свой собственный экземпляр, используя свой GitHub API токен.
Note
Ранги: S (лучший 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). Эта схема рангов основана на системе японской академической оценки. Глобальные данне рассчитываются как взвешенная сумма для каждой статистики (количество коммитов, запросов на включение, обзоров, проблем, звезд и подписчиков), на основе кумулятивной функции распределения [экспоненты](https://wikipedia. org/wiki/exponential_distribution) и log-normal. Реализацию можно изучить здесь: src/calculateRank.js. Круг вокруг рейтинга показывает 100 минус глобальный процент.
Вы можете добавить параметр &hide= чтобы скрыть любую статистику. Значения следует разделять запятыми.
Опции:
&hide=stars,commits,prs,issues,contribs
👀 Показать пример
Вы можете добавить параметр &show= чтобы добавить любую статистику. Значения следует разделять запятыми.
Опции:
&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage
👀 Показать пример
Чтобы включить иконки, добавьте параметр &show_icons=true.
👀 Показать пример
Благодаря встроенным темам вы можете настроить внешний вид карты без какой-либо ручной настройки.
Используйте параметр &theme=THEME_NAME так:
👀 Показать пример
GitHub Readme Stats имеет несколько встроенных тем (такие как dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula).
👀 Посмотреть
Вы можете посмотреть превью всех доступных тем или файл конфигурации темы. Обратите внимание, что мы приостановили добавление новых тем, чтобы уменьшить затраты на обслуживание; все запросы на включение, связанные с новыми темами, будут закрыты.
👀 Показать пример
Поскольку GitHub загружает баннеры из своего CDN, нельзя определить тему browser/GitHub со стороны сервера. Однако существует несколько способов, для создания динамических баннеров на стороне клиента.
Мы добавили transparent тему без фона. Эта тем оптимизирована так, чтобы хорошо выглядеть как на светлых, так и на темных темах GitHub. Используйте параметр &theme=transparent так:
👀 Показать пример
Вы можете использовать параметр bg_color, чтобы сделать любую из доступных тем прозрачной. Это делается путем установки bg_color в цвет с прозрачным альфа-каналом (т.е. bg_color=00000000):
👀 Показать пример
Вы можете использовать тэги темы GitHub для автоматического переключения темы в зависимости от темы пользователя. Для этого добавьте #gh-dark-mode-only или #gh-light-mode-only в конец URL изображения. Этот тэг определяет будет ли отображаться это изображение для пользователей со светлой или темной темой соответственно.
[](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
[](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)👀 Показать пример
Вы можете использовать новую GitHub медиа-функцию в HTML, чтобы указать для для каких пользователей следует отображать изображение. Это делается с помощью HTML-тега <picture> в сочетании с prefers-color-scheme.
<picture>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
media="(prefers-color-scheme: dark)"
/>
<source
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true"
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
/>
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
</picture>👀 Показать пример
GitHub extra pins позволяет вам закрепить более 6 репозиториев в вашем профиле используя Github readme profile. Да! Вы больше не ограниченны всего 6-ю репозиториями.
Вставьте этот код в ваш readme и отредактируйте ссылки.
Конечная точка: api/pin/?username=anuraghazra&repo=github-readme-stats
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Используйте опцию show_owner для добавления имени пользователя владельца репозитория.
👀 Показать пример
GitHub gist pins позволяет вам закрепить gits в вашем Github профиле используя Github readme profile.
Вставьте этот код в ваш readme и отредактируйте ссылки.
Конечная точка: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/)👀 Показать пример
Используйте опцию show_owner для добавления имени пользователя владельца gits'а.
[](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/)👀 Показать пример
На баннере "самые популярные языки" показаны наиболее часто использованные языки программирования пользователя.
Warning
По умолчанию этот баннер отображает статистику только из общедоступных репозиториев. Если вы хотите добавить информацию из частных репозиториев, вам нужно развернуть свой экземпляр используя собственный GitHub API токен.
Note
Этот баннер не отображает уровень навыков пользователя, это показатель GitHub, показывающий на каких языках больше всего кода в репозиториях пользователя. Это новая функция github-readme-stats.
Warning
Этот баннер отображает информацию только из ваших не форкнутых репозиториев, не зависимо от того, кто является автором коммитов. Он не включает ваши вклады в репозиториях других пользователей/организаций. Сейчас нет возможности получить эту информацию через GitHub API. Если вы хотите улучшить это поведение вы можете поддержать запрос этой функции созданный в сообществе GitHub @rickstaa
Warning
Сейчас этот баннер показывает данные только о первых 100 репозиториях, это связанно с ограничениями API GitHub, которое приводит к простоям общественных экземпляров (см. #1471). В будущем это поведение будет улучшено путем действий GitHub'а или добавлением переменных среды для экземпляров пользователей.
Вставьте этот код в ваш readme и отредактируйте ссылки.
Конечная точка: api/top-langs?username=anuraghazra
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Для расчета процентного содержания языков на языковой карте мы используем следующий алгоритм:
ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight)По умолчанию для определения процентного содержания, отображаемого на баннере, используется только количество байтов (т.е. size_weight=1 и count_weight=0). Однако вы можете использовать параметры &size_weight= и &count_weight= для взвешенного расчета процента. Значения должны быть положительными действительными числами. Более подробная информация.
&size_weight=1&count_weight=0- (по умолчанию) Подсчет по количеству байтов.&size_weight=0.5&count_weight=0.5- (рекомендованное) Используется как количество байтов, так и количество репозиториев.&size_weight=0&count_weight=1- Подсчет по количеству репозиториев
👀 Показать пример
Используйте параметр &exclude_repo=repo1,repo2 чтобы исключить определенные репозитории.
👀 Показать пример
Используйте параметр &hide=language1,language2 чтобы скрыть определенные языки.
👀 Показать пример
Используйте опцию &langs_count=, чтобы определить количество языков, отображаемых на баннере. Допустимые значения - целые числа от 1 до 20 (включительно). По умолчанию установлено 5 для normal/donut и 6 для остальных макетов.s.
👀 Показать пример
Используйте параметр &layout=compact чтобы изменить макет на компактный.
👀 Показать пример
Используйте параметр &layout=donut чтобы изменить макет.
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Используйте параметр &layout=donut-vertical чтобы изменить макет.
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Используйте параметр &layout=pie чтобы изменить макет.
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Используйте параметр &hide_progress=true чтобы скрыть шкалу и проценты (макет будет автоматически установлен на compact)
👀 Показать пример
Warning
Имейте в виду, что в настоящее время отображаются данные тотлько из общедоступных профилей WakaTime. Поэтому убедитесь, что в настройках профиля WakaTime включены Display code time publicly и Display languages, editors, os, categories publicly одновременно.
Измените значение ?username= на ваше имя юзернейм в WakaTime.
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Используйте параметр &hide_progress=true чтобы скрыть шкалы
[](https://github.com/anuraghazra/github-readme-stats)👀 Показать пример
Используйте параметр &layout=compact чтобы изменить макет на компактный.
[](https://github.com/anuraghazra/github-readme-stats)
👀 Показать пример
Вы можете настроить внешний вид всех своих карточек по своему усмотрению с помощью параметров URL.
| Параметр | Описание | Тип | Стандартное значение |
|---|---|---|---|
title_color |
Цвет названия баннера. | string (hex color) | 2f80ed |
text_color |
Основной цвет текста. | string (hex color) | 434d58 |
icon_color |
Цвет иконок если возможно. | string (hex color) | 4c71f2 |
border_color |
Цвет границы баннера. Не применится, если hide_border включен. |
string (hex color) | e4e2e2 |
bg_color |
Цвет заднего фона. | string (hex color или градиент в формате angle,start,end) | fffefe |
hide_border |
Скрыть границу баннера. | boolean | false |
theme |
Название темы, выберете из всех доступных тем. | enum | default |
cache_seconds |
Длительность кэширования в секундах (min: 21600 (6 часов), max: 86400 (24 часа)). | integer | 21600 |
locale |
Устанавливает язык в карточке, вы можете посмотреть полный список доступных языков. | enum | en |
border_radius |
Скругление углов. | number | 4.5 |
Warning
Мы используем кеширование, чтобы снизить нагрузку на наши серверы (см. #1371). Наши баннеры имеют длительность кеша 6 часов (21600 секунд). Обратите внимание, что длительность кэша может быть от 6 до 24 часов. Если вы хотите чтобы ваша статистика обновлялась чаще, вы можете развернуть свой экземпляр и установить переменную среды CACHE_SECONDS по своему усмотрению.
Вам необходимо указать несколько значений, разделенных запятыми в таком формате:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Список доступных языков:
|
|
|
Если мы не поддерживаем ваш язык, рассмотрите возможность внести свой вклад! Более подробную информацию о том, как это сделать, вы можете найти в наших рекомендациях для авторов.
| Параметр | Описание | Тип | Стандартное значение |
|---|---|---|---|
hide |
Спрятать определенные значения статистики. | string (comma-separated values) | null |
hide_title |
Спрятать название вашего баннера. | boolean | false |
card_width |
Ширина баннера в пикселях. | number | 500px (примерно) |
hide_rank |
Скрывает ранг и автоматически уменьшить размер баннера. | boolean | false |
rank_icon |
Установить альтернативную иконку ранга (github, percentile или default). |
enum | default |
show_icons |
Показывать иконки рядом со всеми данными. | boolean | false |
include_all_commits |
Подсчитайте общее количество коммитов, а не только коммиты текущего года. | boolean | false |
line_height |
Межстрочный отступ. | integer | 25 |
exclude_repo |
Исключает указанные репозитории. | string (значения через запятую) | null |
custom_title |
Установить свое название баннера. | string | <username> GitHub Stats |
text_bold |
Использовать жирный шрифт. | boolean | true |
disable_animations |
Отключает всю анимацию на баннере. | boolean | false |
ring_color |
Цвет кольца ранга. | string (hex color) | 2f80ed |
number_format |
Переключает между двумя доступными форматами отображения значений баннера: «короткий» (т.е. «6,6К») или «длинный» (т.е. «6626»). | enum | short |
show |
Показывает дополнительные элементы на карточке статистики (reviews, discussions_started, discussions_ Answered, prs_merged или prs_merged_percentage). |
string (comma-separated values) | null |
Note
Если hide_rank=true, минимальная ширина карточки составляет 270 пикселей + длина заголовка и отступы.
| Параметр | Описание | Тип | Стандартное значение |
|---|---|---|---|
show_owner |
Показать имя владельца репозитория. | boolean | false |
description_lines_count |
Ручная установка количество строк описания. Значения должно быть между 1 и 3. Если параметр не указан, значение будет регулироваться автоматически. | number | null |
| Параметр | Описание | Тип | Стандартное значение |
|---|---|---|---|
show_owner |
Показать имя владельца gist'а. | boolean | false |
| Параметр | Описание | Тип | Стандартное значение |
|---|---|---|---|
hide |
Скрыть указанные языки с баннера. | string (значения, разделенные запятыми) | null |
hide_title |
Скрыть название баннера. | boolean | false |
layout |
Установить один из 5 макетов: normal / compact / donut / donut-vertical / pie. |
enum | normal |
card_width |
Установить ширину баннера. | number | 300 |
langs_count |
Установить количество отображаемых языков (значение между 1 и 20). | integer | 5 для normal и donut, 6 для остальных макетов |
exclude_repo |
Исключить указанные репозитория. | string (значения, разделенные запятыми) | null |
custom_title |
Установить свое название баннера. | string | Most Used Languages |
disable_animations |
Отключить все анимации баннера. | boolean | false |
hide_progress |
Используется в компактном макете, скрывает шкалы и проценты, оставляя только названия языков. | boolean | false |
size_weight |
Настраивает алгоритм статистики языка (см. Language stats algorithm). | integer | 1 |
count_weight |
Настраивает алгоритм статистики языка (см. Language stats algorithm). | integer | 0 |
Warning
Названия языков должны быть URI-escaped, как указано в процентном кодировании
(т.е.: c++ должен стать c%2B%2B, jupyter notebook должен стать jupyter%20notebook, и т.д.)
Используйте urlencoder.org чтобы делать это автоматически .
| Параметр | Описание | Тип | Стандартное значение |
|---|---|---|---|
hide |
Скрыть указанные языки с баннера. | string (значения, разделенные запятыми) | null |
hide_title |
Скрыть название баннера. | boolean | false |
line_height |
Установить отступ между строк. | integer | 25 |
hide_progress |
Скрыть шкалу и проценты. | boolean | false |
custom_title |
Установить свое название баннера. | string | WakaTime Stats |
layout |
Установить один из доступных макетов: default / compact. |
enum | default |
langs_count |
Ограничить количество языков на баннере, по умолчанию отображаются все. | integer | null |
api_domain |
Установить свой домен API для баннера, например использовать сервисы Hakatime или Wakapi | string | wakatime.com |
display_format |
Установить формат отображения статистики. Выберете time или percent для отображения статистики по времени или проценту. |
enum | time |
disable_animations |
Отключить все анимации баннера. | boolean | false |
👀 Показать
- Default
- Hiding specific stats
- Showing additional stats
- Showing icons
- Shows Github logo instead rank level
- Shows user rank percentile instead of rank level
- Customize Border Color
- Include All Commits
- Themes
Choose from any of the default themes
- Gradient
- Customizing stats card
- Setting card locale
- Customizing repo card
- Gist card
- Customizing gist card
- Top languages
- WakaTime card
По умолчанию GitHub оставляет зазор между баннерами. Чтобы разместить их вплотную используйте такой подход:
<a href="https://github.com/anuraghazra/github-readme-stats">
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api?username=anuraghazra" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
</a><a href="https://github.com/anuraghazra/github-readme-stats">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>👀 Показать пример
- По умолчанию
- Используя предложенный подход
Поскольку GitHub API разрешает только 5 тысяч запросов в час, мой https://github-readme-stats.vercel.app/api сталкивается с ограничениями в скорости.
Если вы развернете собственный экземпляр на своем сервере Vercel, вам не о чем беспокоится.
Нажмите кнопку развертывания, чтобы начать!
Note
Начиная с #58, мы сможем обработать более 5 тысяч запросов в час и иметь меньше проблем с ограничениями 😁.
Note
Если вы используете тарифный план Pro (т.е. платный), то значение maxDuration в vercel.json может быть увеличено, если время ожидания вашего экземпляра часто истекает во время запроса баннера.
Рекомендуется поддерживать это значение ниже 30 секунд, чтобы предотвратить чрезмерное использование памяти.
🛠️ Пошаговый гайд по настройке экземпляра на vercel
- Откройте vercel.com.
- Войдите с помощью GitHub, нажав на
Log in, а затем наContinue with GitHub. - Во время входа через GitHub разрешите доступ ко всем репозиториям, если это потребуется.
- Сделайте форк этого репозитория.
- Вернитесь в свой Vercel dashboard.
- Для импорта проекта, нажмите на
Add New...и выберетеProject. - Нажмите на
Continue with GitHub, найдите нужный репозиторий и импортируйте его, нажав наImport. Кроме того, вы можете импортировать сторонний репозиторий, используяImport Third-Party Git Repository ->в нижней части страницы. - Создайте токен личного доступа GitHub (PAT) здесь и разрешите
repoиuser(это позволит получить доступ к частным репозиториям и информации о пользователе). - Добавьте PAT в переменную среды
PAT_1(как показано). - Нажмите
deploy, и все готово. Посмотрите на свои домены, чтобы использовать свой API!
Warning
Этот способ официально не поддерживается и был добавлен только для удовлетворения некоторых конкретных случаев, когда Vercel не может быть использован (например #2341). Поэтому этот метод имеет ограниченную поддержку и не рекомендуется.
🛠️ Пошаговый гайд по настройке экземпляра на других платформах
- Сделайте форк или клонируйте репозиторий в соответствии с потребностью.
- Добавьте
expressв раздел зависимостейpackage.jsonhttps://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L54-L61 - При необходимости запустите
npm i(для первоначальной настройки) - Запустите
node express.js, чтобы запустить сервер, или установите точку входаexpress.jsвpackage.json, если вы выполняете развертывание в управляемой службе. https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L11 - Все готово 🎉
Github Readme Stats содержит несколько переменных среды, которые можно использовать для снятия ограничений скорости:
CACHE_SECONDS: эта переменная среды имеет приоритет над минимальными и максимальными значениями кэша и позволяет обойти эти значения для своего экземпляра.
См. документацию Vercel о добавлении этих переменных среды в проект.
Вам следует поддерживать свой форк и, следовательно, свой экземпляр в актуальном состоянии с исходным репозиторием. Чтобы это сделать используйте кнопку GitHub Sync Fork Вы также можете использовать пакет pull, созданный @wei, чтобы автоматизировать данный процесс.
Я открываю исходный код почти всего, чего могу, и стараюсь отвечать всем, кто нуждается в моей помощи. Очевидно что это требует времени. Вы можете пользоваться этими услугами бесплатно.
Однако, если вы пользуетесь моими услугами и довольны ими или вы просто хотите побудить меня продолжать создавать что-то, вы можете поддержать меня меня несколькими способами:
- Добавить обратные ссылки на мой проект, если вы используете github-readme-stats в своем readme файле. :D
- Поставить звезду и поделится проектом. 🚀
- Вы можете сделать единоразовое пожертвование через PayPal. Я, наверное, куплю
кофечай. 🍵
Спасибо! ❤️
Соучастие приветствуется! <3
Сделано с любовью ❤️ и JavaScript.