github readme stats
1.0.0
Получите динамически сгенерированную статистику GitHub на ваших чтениях!
Просмотреть демо · Ошибка отчета · Функция запроса · FAQ · Задать вопрос
Français · 简体中文 · Español · Deutsch · 日本語 · Português brasileiro · итальян · · nederlands · नेपाली · türkse
Обратите внимание, что переводы документации могут быть устаревшими; Попробуйте использовать документацию по английскому языку, если это возможно.
Любите проект? Пожалуйста, рассмотрите возможность пожертвования, чтобы помочь ему улучшить!
Вы думаете о поддержке проекта, пожертвовав мне? Пожалуйста, не !!!
Недавно Индия перенесла одно из самых разрушительных аварий на поезде, и ваша помощь будет очень ценной для людей, которые пострадали от этой трагедии.
Пожалуйста, посетите эту ссылку и сделайте небольшое пожертвование, чтобы помочь нуждающимся людям. Небольшое пожертвование проходит долгий путь. ❤
Важный
Поскольку API GitHub допускает только 5K запросов в час на учетную запись пользователя, общедоступный экземпляр Vercel, размещенный на https://github-readme-stats.vercel.app/api возможно, может достичь ограничителя скорости (см. #1471). Мы используем кэширование, чтобы предотвратить это (см. Https://github.com/anuraghazra/github-readme-stats#common-options). Вы можете отключить эти защиты ограничения по скорости, развернув свой собственный экземпляр Vercel.
Важный
Мы маленькая команда, и для расстановки приоритетов мы полагаемся на продовольствия? Мы используем Top Assues Dashboard для отслеживания спроса сообщества (см. #1935). Не стесняйтесь поднять проблемы и привлечь вас заинтересованные.
Скопируйте и вставьте это в свою отметки, и это все. Простой!
Измените ?username= значение вашего имени пользователя GitHub.
[ ![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra )] ( https://github.com/anuraghazra/github-readme-stats ) Предупреждение
По умолчанию карта статистики показывает только статистику, такую как звезды, коммиты и запросы на получение публичных репозиториев. Чтобы показать личную статистику на карте статистики, вы должны развернуть свой собственный экземпляр, используя свой собственный токен API GitHub.
Примечание
Доступные ранги составляют S (верхняя 1%), A+ (12,5%), A (25%), A- (37,5%), B+ (50%), B (62,5%), B- (75%), C+ (87,5%) и C (все). Эта схема ранжирования основана на японской системе академической оценки. Глобальный процентиль рассчитывается как взвешенная сумма процентилей для каждой статистики (количество коммитов, запросов на привлечение, обзоров, проблем, звезд и последователей), на основе совокупной функции распределения экспоненциального и нормального распределения. Реализация может быть исследована на src/calculaterank.js. Круг вокруг ранга показывает 100 минус мировой процентиль.
Вы можете передать параметр запроса &hide= любую конкретную статистику с разделенными запятыми значениями.
Варианты:
&hide=stars,commits,prs,issues,contribs
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs ) Вы можете передать параметр запроса &show= чтобы показать любую конкретную дополнительную статистику с разделенными запятыми значениями.
Параметры:
&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage ) Чтобы включить значки, вы можете передавать &show_icons=true в параметре запроса, как так:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true )С встроенными темами вы можете настроить внешний вид карты, не выполняя ручную настройку.
Использовать &theme=THEME_NAME Параметр как SO:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical ) Github Readme Stats поставляется с несколькими встроенными темами (например, dark , radical , merko , gruvbox , tokyonight , onedark , cobalt , synthwave , highcontrast , dracula ).
Вы можете посмотреть предварительный просмотр для всех доступных тем или оформить файл конфигурации темы. Обратите внимание, что мы остановили добавление новых тем, чтобы уменьшить усилия по техническому обслуживанию; Все запросы на притяжение, связанные с новыми темами, будут закрыты.
Поскольку GitHub повторно загрузит карты и будет обслуживать их из CDN, мы не можем вывести тему браузера/GitHub на стороне сервера. Однако есть четыре метода, которые вы можете использовать для создания динамических тем на стороне клиента.
Мы включили transparent тему, которая имеет прозрачный фон. Эта тема оптимизирована, чтобы хорошо выглядеть на темных и легких темах GitHub. Вы можете включить эту тему, используя &theme=transparent параметр, как SO:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent ) Вы можете использовать параметр bg_color , чтобы сделать любую из доступных тем прозрачными. Это делается путем установки bg_color на цвет с прозрачным альфа -каналом (то есть bg_color=00000000 ):
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000 ) Вы можете автоматически использовать теги контекста темы GitHub для автоматического переключения темы на основе темы пользователя GitHub. Это делается путем добавления #gh-dark-mode-only или #gh-light-mode-only к концу URL-адреса изображения. Этот тег будет определять, отображается ли изображение, указанное в отметки, только зрителям, использующим свет или темную тему GitHub:
[ ![ Anurag's GitHub stats-Dark ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only )] ( https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only )
[ ![ Anurag's GitHub stats-Light ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only )] ( https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only ) Вы можете использовать новую функцию Mithub в HTML, чтобы указать, отображать ли изображения для световых или темных тем. Это делается с использованием элемента HTML <picture> в сочетании с функцией Media 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 >Вы можете настроить внешний вид всех ваших карт, как пожелаете с параметрами URL.
| Имя | Описание | Тип | Значение по умолчанию |
|---|---|---|---|
title_color | Цвет заголовка карты. | Строка (HEX Color) | 2f80ed |
text_color | Цвет текста тела. | Строка (HEX Color) | 434d58 |
icon_color | Значок цвета, если таковые имеются. | Строка (HEX Color) | 4c71f2 |
border_color | КАРТА РЕМЖЕР. Не применяется, когда hide_border включен. | Строка (HEX Color) | e4e2e2 |
bg_color | Цвет фона карт. | Строка (шестигранный цвет или градиент в форме угла, начала, конец ) | fffefe |
hide_border | Скрывает границу карты. | логический | false |
theme | Название темы, выберите из всех доступных тем. | перевозить | default |
cache_seconds | Устанавливает заголовок кэша вручную (мин: 21600, макс: 86400). | целое число | 21600 |
locale | Устанавливает язык в карте, вы можете проверить полный список доступных локалов здесь. | перевозить | en |
border_radius | Угловой округление на карте. | число | 4.5 |
Предупреждение
Мы используем кэширование, чтобы уменьшить нагрузку на наших серверах (см. #1471 (комментарий)). Наши карты имеют кэш по умолчанию 6 часов (21600 секунд). Кроме того, обратите внимание, что кэш зажимается как минимум 6 часов и максимум 24 часа. Если вы хотите, чтобы данные на вашей статистической карте чаще обновлялись, вы можете развернуть свой собственный экземпляр и установить переменную среды CACHE_SECONDS на значение по вашему выбору.
Вы можете предоставить несколько разделенных запятых значений в опции BG_COLOR, чтобы отобразить градиент со следующим форматом:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Вот список всех доступных локалов:
|
|
|
Если мы не поддерживаем ваш язык, пожалуйста, рассмотрите возможность внести свой вклад! Вы можете найти больше информации о том, как это сделать в наших рекомендациях.
| Имя | Описание | Тип | Значение по умолчанию |
|---|---|---|---|
hide | Скрывает указанные элементы из статистики. | Строка (разделенные запятыми значения) | null |
hide_title | Скрывает заголовок вашей статистической карты. | логический | false |
card_width | Устанавливает ширину карты вручную. | число | 500px (approx.) |
hide_rank | Скрывает ранги и автоматически изменяет размер ширины карты. | логический | false |
rank_icon | Показывает альтернативный значок ранга (то есть github , percentile или default ). | перевозить | default |
show_icons | Показывает иконы возле всех статистических данных. | логический | false |
include_all_commits | Подсчитано общее количество коммитов вместо только текущего года. | логический | false |
line_height | Устанавливает высоту строки между текстом. | целое число | 25 |
exclude_repo | Исключает указанные репозитории. | Строка (разделенные запятыми значения) | null |
custom_title | Устанавливает пользовательский заголовок для карты. | нить | <username> GitHub Stats |
text_bold | Использует смелый текст. | логический | true |
disable_animations | Отключает все анимации в карте. | логический | false |
ring_color | Цвет круга ранга. | Строка (HEX Color) | 2f80ed |
number_format | Переключатели между двумя доступными форматами для отображения значений карты short (т.е. 6.6k ) и long (т.е. 6626 ). | перевозить | short |
show | Показывает дополнительные элементы на карте статистики (то есть reviews , discussions_started , discussions_answered , prs_merged или prs_merged_percentage ). | Строка (разделенные запятыми значения) | null |
Примечание
Когда hide_rank = true , минимальная ширина карты составляет 270 px + длина заголовка и прокладка.
| Имя | Описание | Тип | Значение по умолчанию |
|---|---|---|---|
show_owner | Показывает имя владельца репо. | логический | false |
description_lines_count | Вручную установите количество строк для описания. Указанное значение будет закреплено от 1 до 3. Если этот параметр не указан, количество строк будет автоматически скорректировано в соответствии с фактической длиной описания. | число | null |
| Имя | Описание | Тип | Значение по умолчанию |
|---|---|---|---|
show_owner | Показывает имя владельца Гиста. | логический | false |
| Имя | Описание | Тип | Значение по умолчанию |
|---|---|---|---|
hide | Скрывает указанные языки из карты. | Строка (разделенные запятыми значения) | null |
hide_title | Скрывает заголовок вашей карты. | логический | false |
layout | Переключатели между пятью доступными макетами normal и compact и donut и donut-vertical и pie . | перевозить | normal |
card_width | Устанавливает ширину карты вручную. | число | 300 |
langs_count | Показывает больше языков на карте, между 1-20. | целое число | 5 для normal и donut , 6 для других макетов |
exclude_repo | Исключает указанные репозитории. | Строка (разделенные запятыми значения) | null |
custom_title | Устанавливает пользовательский заголовок для карты. | нить | Most Used Languages |
disable_animations | Отключает все анимации в карте. | логический | false |
hide_progress | Использует опцию компактного макета, скрывает процент и удаляет стержни. | логический | false |
size_weight | Настраивает алгоритм статистики языка (см. Алгоритм статистики языка). | целое число | 1 |
count_weight | Настраивает алгоритм статистики языка (см. Алгоритм статистики языка). | целое число | 0 |
Предупреждение
Языковые названия должны быть уристаличны, как указано в процентах кодирования (то есть: c++ должен стать c%2B%2B , jupyter notebook должен стать jupyter%20notebook и т. Д.) Вы можете использовать urlencoder.org, чтобы помочь вам сделать это автоматически.
| Имя | Описание | Тип | Значение по умолчанию |
|---|---|---|---|
hide | Скрывает языки, указанные из карты. | Строка (разделенные запятыми значения) | null |
hide_title | Скрывает заголовок вашей карты. | логический | false |
line_height | Устанавливает высоту строки между текстом. | целое число | 25 |
hide_progress | Скрывает планшн и процент. | логический | false |
custom_title | Устанавливает пользовательский заголовок для карты. | нить | WakaTime Stats |
layout | Переключатели между двумя доступными макетами default и compact . | перевозить | default |
langs_count | Ограничивает количество языков на карте, по умолчанию на все зарегистрированные языки. | целое число | null |
api_domain | Устанавливает пользовательский домен API для карты, например, для использования таких услуг, как Hakatime или Wakapi | нить | wakatime.com |
display_format | Устанавливает формат отображения статистики Wakatime. Выберите time , чтобы отобразить статистику на основе времени или percent , чтобы показать процент. | перевозить | time |
disable_animations | Отключает все анимации в карте. | логический | false |
Дополнительные контакты Github позволяют прикреплять более 6 репозиториев в вашем профиле, используя профиль readme GitHub.
Ура! Вы больше не ограничены 6 закрепленными репозиториями.
Скопируйте этот код в свой README и измените ссылки.
Конечная точка: api/pin?username=anuraghazra&repo=github-readme-stats
[ ![ Readme Card ] ( https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats )] ( https://github.com/anuraghazra/github-readme-stats )Используйте опцию запроса show_owner, чтобы включить имя пользователя владельца Repo
Вывод Github Gist позволяет прикреплять GIST в вашем профиле GitHub, используя профиль readme GitHub.
Скопируйте этот код в свой README и измените ссылки.
Конечная точка: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[ ![ Gist Card ] ( https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d )] ( https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/ )Используйте опцию запроса Show_owner, чтобы включить имя пользователя GIST
На карте Top Languages показывается наиболее часто используемые языки пользователя GitHub.
Предупреждение
По умолчанию языковая карта показывает языковые результаты только из общественных репозиториев. Чтобы включить языки, используемые в частные репозитории, вы должны развернуть свой собственный экземпляр, используя свой собственный токен API GitHub.
Примечание
Лучшие языки не указывают на уровень навыков пользователя или что -то в этом роде; Это метрика GitHub, чтобы определить, какие языки имеют наибольшее код на GitHub. Это новая особенность GitHub-Readme-Stats.
Предупреждение
Эта карта показывает использование языка только в ваших собственных неполных репозиториях, не в зависимости от того, кто является автором Commits. Он не включает ваши вклад в другие репозитории пользователей/организации. В настоящее время нет возможности получить эти данные от GitHub API. Если вы хотите, чтобы это поведение было улучшено, вы можете поддержать этот запрос функции, созданный @RickStaa в сообществе GitHub.
Предупреждение
В настоящее время на этой карте показаны данные только о первых 100 репозиториях. Это связано с ограничениями Github API, которые вызывают время общественных случаев (см. #1471). В будущем это поведение будет улучшено за счет выпуска действия GitHub или предоставления переменных среды для собственных экземпляров пользователя.
Скопируйте этот код в свой README и измените ссылки.
Конечная точка: api/top-langs?username=anuraghazra
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/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 - Заказы по счету репо ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5 ) Вы можете использовать параметр &exclude_repo=repo1,repo2 чтобы исключить отдельные репозитории.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io ) Вы можете использовать &hide=language1,language2 параметр, чтобы скрыть отдельные языки.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html ) Вы можете использовать опцию &langs_count= для увеличения или уменьшения количества языков, показанных на карте. Допустимые значения составляют целые числа от 1 до 20 (включительно). По умолчанию он был установлен на 5 для normal и donut и 6 для других макетов.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8 ) Вы можете использовать опцию &layout=compact чтобы изменить дизайн карты.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact ) Вы можете использовать опцию &layout=donut , чтобы изменить дизайн карты.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut )] ( https://github.com/anuraghazra/github-readme-stats ) Вы можете использовать опцию &layout=donut-vertical чтобы изменить дизайн карты.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut-vertical )] ( https://github.com/anuraghazra/github-readme-stats ) Вы можете использовать опцию &layout=pie , чтобы изменить дизайн карты.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=pie )] ( https://github.com/anuraghazra/github-readme-stats ) Вы можете использовать опцию &hide_progress=true чтобы скрыть проценты и панели хода (макет будет автоматически установлен на compact ).
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true )Предупреждение
Пожалуйста, имейте в виду, что в настоящее время мы показываем только данные из профилей Wakatime, которые являются общедоступными. Поэтому вы должны убедиться, что оба Display code time publicly и Display languages, editors, os, categories publicly включены.
Измените ?username= значение вашего имени пользователя Wakatime.
[ ![ Harlok's WakaTime stats ] ( https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs )] ( https://github.com/anuraghazra/github-readme-stats )Выберите из любой из тем по умолчанию
По умолчанию 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 > Поскольку API GitHub допускает только 5K запросов в час, мой https://github-readme-stats.vercel.app/api может достичь ограничителя. Если вы размещаете его на своем собственном сервере Vercel, вам не нужно ни о чем беспокоиться. Нажмите кнопку «Развертывание», чтобы начать!
Примечание
С № 58 мы должны иметь возможность обрабатывать более чем 5K -запросы и иметь меньше проблем с простоями?
Примечание
Если вы находитесь в плане Vercel Pro (т.е. заплаченным), значение максимальности, найденное в Vercel.json, может быть увеличено, когда ваш экземпляр Vercel часто раздается во время запроса карты. Вам рекомендуется сохранить это значение ниже 30 секунд, чтобы предотвратить высокое использование памяти.
Log in .Continue with GitHub .Add New... и выберите опцию Project .Continue with GitHub , поиск необходимого репозитория GIT и импортируйте ее, нажав кнопку Import . В качестве альтернативы вы можете импортировать сторонний репозиторий GIT, используя Import Third-Party Git Repository -> в нижней части страницы.repo и user (это позволяет получить доступ к частной репо и статистике пользователей).PAT_1 (как показано).Предупреждение
Этот способ использования GRS официально не поддерживается и был добавлен, чтобы удовлетворить некоторые конкретные варианты использования, когда Vercel нельзя использовать (например, #2341). Следовательно, поддержка этого метода ограничена.
express в раздел зависимости package.jsongithub-readme-stats/package.json
Строки от 54 до 61 в BA7C2F8
npm i при необходимости (начальная настройка)node express.js , чтобы запустить сервер, или установить точку входа в express.js в package.json , если вы развернете в управляемой службеgithub-readme-stats/package.json
Строка 11 в BA7C2F8
Статистика Github Readme содержит несколько переменных среды Vercel, которые можно использовать для удаления защиты ограничения скорости:
CACHE_SECONDS : эта переменная среды имеет приоритет над минимальными и максимальными значениями нашего кэша и может обойти эти значения для самостоятельных экземпляров версии.См. Документацию Vercel о добавлении этих переменных среды в экземпляр Vercel.
Вы можете сохранить свою вилку, и, следовательно, ваш частный экземпляр Vercel актуально с UPSTREAM, используя кнопку Sync Fork от GitHub. Вы также можете использовать пакет Pull, созданный @Wei для автоматизации этого процесса.
Я открыл источник почти все, что могу, и пытаюсь ответить всем, кто нуждается в помощи, используя эти проекты. Очевидно, это требует времени. Вы можете использовать эту услугу бесплатно.
Однако, если вы используете этот проект и довольны им или просто хотите побудить меня продолжать создавать вещи, есть несколько способов сделать это:
Спасибо! ❤
Взносы приветствуются! <3
Сделано с ❤ и JavaScript.
