github readme stats
1.0.0
Obtenha as estatísticas do Github gerado dinamicamente em seus Readmes!
Veja a demonstração · Relatório Bug · Recurso de solicitação · FAQ · Faça uma pergunta
Français · 简体中文 · Español · Deutsch · · Português Brasileiro · italiano · 한국어 · Nederlands · नेपाली · türkçe
Observe que as traduções de documentação podem estar desatualizadas; Tente usar a documentação em inglês, se possível.
Ame o projeto? Por favor, considere doar para ajudá -lo a melhorar!
Você está pensando em apoiar o projeto doando para mim? Por favor, não !!!
A Índia sofreu recentemente um dos acidentes de trem mais devastadores, e sua ajuda será imensamente valiosa para as pessoas que foram afetadas por essa tragédia.
Visite este link e faça uma pequena doação para ajudar as pessoas necessitadas. Uma pequena doação ajuda muito. ❤️
Importante
Como a API do GitHub permite apenas 5k solicitações por hora por conta de usuário, a instância pública do VERCEL hospedada em https://github-readme-stats.vercel.app/api stats.vercel.app/api poderia atingir o limitador de taxa (consulte #1471). Usamos o cache para impedir que isso aconteça (consulte https://github.com/anuraghazra/github-readme-stats#common-options). Você pode desativar essas proteções de limite de taxa implantando sua própria instância de vercel.
Importante
Somos uma equipe pequena e, para priorizar, contamos com votos? Utilizamos o painel principal de problemas para rastrear a demanda da comunidade (ver #1935). Não hesite em votar nos problemas e puxar solicitações em que você esteja interessado. Trabalharemos no primeiro voto primeiro.
Copie e cole isso em sua remarcação, e é isso. Simples!
Altere o ?username= valor para o seu nome de usuário do github.
[ ![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra )] ( https://github.com/anuraghazra/github-readme-stats ) Aviso
Por padrão, o cartão STATS mostra apenas estatísticas como estrelas, compromissos e solicitações de repositórios públicos. Para mostrar estatísticas particulares no cartão STATS, você deve implantar sua própria instância usando seu próprio token da API do GitHub.
Observação
As classificações disponíveis são S (1%superior), A+ (12,5%), A (25%), A- (37,5%), B+ (50%), B (62,5%), B- (75%), C+ (87,5%) e C (todos). Esse esquema de classificação é baseado no sistema de classificação acadêmica japonesa. O percentil global é calculado como uma soma ponderada de percentis para cada estatística (número de comissões, solicitações de puxar, revisões, questões, estrelas e seguidores), com base na função de distribuição cumulativa das distribuições exponenciais e log-normais. A implementação pode ser investigada no SRC/Calculaterank.js. O círculo ao redor da classificação mostra 100 menos o percentil global.
Você pode passar por um parâmetro de consulta &hide= ocultar estatísticas específicas com valores separados por vírgula.
Opções:
&hide=stars,commits,prs,issues,contribs
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs ) Você pode passar por um parâmetro de consulta &show= para mostrar estatísticas adicionais específicas com valores separados por vírgula.
Opções:
&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 ) Para ativar os ícones, você pode passar &show_icons=true no parâmetro de consulta, como assim:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true )Com os temas embutidos, você pode personalizar a aparência do cartão sem fazer nenhuma personalização manual.
Uso &theme=THEME_NAME como assim:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical ) As estatísticas do GitHub ReadMe vem com vários temas embutidos (por exemplo, dark , radical , merko , gruvbox , tokyonight , onedark , cobalt , synthwave , highcontrast , dracula ).
Você pode procurar uma visualização para todos os temas disponíveis ou verificar o arquivo de configuração do tema. Observe que paramos na adição de novos temas para diminuir os esforços de manutenção; Todas as solicitações de tração relacionadas a novos temas serão fechadas.
Como o Github reaparecerá os cartões e os servirá de sua CDN, não podemos inferir o tema do navegador/github no lado do servidor. No entanto, existem quatro métodos que você pode usar para criar temas de dinâmica no lado do cliente.
Incluímos um tema transparent que possui um fundo transparente. Este tema é otimizado para ficar bem nos temas padrão escuros e claros do Github. Você pode ativar esse tema usando o parâmetro &theme=transparent como assim:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent ) Você pode usar o parâmetro bg_color para tornar transparente qualquer um dos temas disponíveis. Isso é feito definindo o bg_color para uma cor com um canal alfa transparente (ou seja, bg_color=00000000 ):
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000 ) Você pode usar as tags de contexto de tema do Github para alternar o tema com base no tema do Github do usuário automaticamente. Isso é feito anexando #gh-dark-mode-only ou #gh-light-mode-only até o final de um URL da imagem. Esta tag definirá se a imagem especificada no Markdown é mostrada apenas aos espectadores usando um tema leve ou escuro do 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 ) Você pode usar o novo recurso de mídia do Github no HTML para especificar se deve exibir imagens para temas claros ou escuros. Isso é feito usando o elemento HTML <picture> em combinação com o recurso de mídia 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 >Você pode personalizar a aparência de todos os seus cartões, como desejar com parâmetros de URL.
| Nome | Descrição | Tipo | Valor padrão |
|---|---|---|---|
title_color | Cor do título do cartão. | string (cor hexadecimal) | 2f80ed |
text_color | Cor do texto corporal. | string (cor hexadecimal) | 434d58 |
icon_color | Ícones cor, se disponível. | string (cor hexadecimal) | 4c71f2 |
border_color | Cor da borda do cartão. Não se aplica quando hide_border está ativado. | string (cor hexadecimal) | e4e2e2 |
bg_color | Cor de fundo do cartão. | String (cor hexadecimal ou gradiente na forma de ângulo, início, fim ) | fffefe |
hide_border | Esconde a fronteira do cartão. | booleano | false |
theme | Nome do tema, escolha entre todos os temas disponíveis. | enum | default |
cache_seconds | Define o cabeçalho do cache manualmente (min: 21600, máximo: 86400). | Inteiro | 21600 |
locale | Define o idioma no cartão, você pode verificar a lista completa dos locais disponíveis aqui. | enum | en |
border_radius | ROUNTE DE CANTO NO CARRO. | número | 4.5 |
Aviso
Usamos o cache para diminuir a carga em nossos servidores (consulte #1471 (comentário)). Nossos cartões têm um cache padrão de 6 horas (21600 segundos). Além disso, observe que o cache está preso a um mínimo de 6 horas e no máximo 24 horas. Se você deseja que os dados no seu cartão de estatística sejam atualizados com mais frequência, poderá implantar sua própria instância e definir o ambiente variável CACHE_SECONDS para um valor de sua escolha.
Você pode fornecer vários valores separados por vírgula na opção BG_COLOR para renderizar um gradiente com o seguinte formato:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Aqui está uma lista de todos os locais disponíveis:
|
|
|
Se não apoiarmos seu idioma, considere contribuir! Você pode encontrar mais informações sobre como fazê -lo em nossas diretrizes contribuintes.
| Nome | Descrição | Tipo | Valor padrão |
|---|---|---|---|
hide | Esconde os itens especificados das estatísticas. | String (valores separados por vírgula) | null |
hide_title | Esconde o título do seu cartão STATS. | booleano | false |
card_width | Define a largura do cartão manualmente. | número | 500px (approx.) |
hide_rank | Esconde a classificação e redimensiona automaticamente a largura do cartão. | booleano | false |
rank_icon | Mostra o ícone de classificação alternativa (ou seja, github , percentile ou default ). | enum | default |
show_icons | Mostra ícones perto de todas as estatísticas. | booleano | false |
include_all_commits | A contagem total de compromissos, em vez de apenas os compromissos do ano atual. | booleano | false |
line_height | Define a altura da linha entre o texto. | Inteiro | 25 |
exclude_repo | Exclui repositórios especificados. | String (valores separados por vírgula) | null |
custom_title | Define um título personalizado para o cartão. | corda | <username> GitHub Stats |
text_bold | Usa texto em negrito. | booleano | true |
disable_animations | Desative todas as animações no cartão. | booleano | false |
ring_color | Cor do círculo de classificação. | string (cor hexadecimal) | 2f80ed |
number_format | Interruptores entre dois formatos disponíveis para exibir os valores da placa short (ou seja, 6.6k ) e long (ou seja, 6626 ). | enum | short |
show | Mostra itens adicionais no cartão STATS (ou seja, reviews , discussions_started , discussions_answered , prs_merged ou prs_merged_percentage ). | String (valores separados por vírgula) | null |
Observação
Quando hide_rank = true , a largura mínima do cartão é 270 px + o comprimento do título e o preenchimento.
| Nome | Descrição | Tipo | Valor padrão |
|---|---|---|---|
show_owner | Mostra o nome do proprietário do repo. | booleano | false |
description_lines_count | Defina manualmente o número de linhas para a descrição. O valor especificado será preso entre 1 e 3. Se este parâmetro não for especificado, o número de linhas será ajustado automaticamente de acordo com o comprimento real da descrição. | número | null |
| Nome | Descrição | Tipo | Valor padrão |
|---|---|---|---|
show_owner | Mostra o nome do proprietário da essência. | booleano | false |
| Nome | Descrição | Tipo | Valor padrão |
|---|---|---|---|
hide | Esconde os idiomas especificados do cartão. | String (valores separados por vírgula) | null |
hide_title | Esconde o título do seu cartão. | booleano | false |
layout | Interruptores entre cinco layouts disponíveis normal e compact e donut e donut-vertical e pie . | enum | normal |
card_width | Define a largura do cartão manualmente. | número | 300 |
langs_count | Mostra mais idiomas no cartão, entre 1-20. | Inteiro | 5 para normal e donut , 6 para outros layouts |
exclude_repo | Exclui repositórios especificados. | String (valores separados por vírgula) | null |
custom_title | Define um título personalizado para o cartão. | corda | Most Used Languages |
disable_animations | Desative todas as animações no cartão. | booleano | false |
hide_progress | Usa a opção de layout compacta, oculta porcentagens e remove as barras. | booleano | false |
size_weight | Configura o algoritmo de estatísticas de idiomas (consulte o algoritmo de estatísticas de idiomas). | Inteiro | 1 |
count_weight | Configura o algoritmo de estatísticas de idiomas (consulte o algoritmo de estatísticas de idiomas). | Inteiro | 0 |
Aviso
Os nomes de idiomas devem ser escapados de urina, conforme especificado na codificação de porcentagem (o isto é: c++ deve se tornar c%2B%2B , jupyter notebook deve se tornar jupyter%20notebook , etc.) Você pode usar o urlencoder.org para ajudá-lo a fazer isso automaticamente.
| Nome | Descrição | Tipo | Valor padrão |
|---|---|---|---|
hide | Esconde os idiomas especificados do cartão. | String (valores separados por vírgula) | null |
hide_title | Esconde o título do seu cartão. | booleano | false |
line_height | Define a altura da linha entre o texto. | Inteiro | 25 |
hide_progress | Esconde a barra de progresso e a porcentagem. | booleano | false |
custom_title | Define um título personalizado para o cartão. | corda | WakaTime Stats |
layout | Interruptores entre dois layouts disponíveis default e compact . | enum | default |
langs_count | Limita o número de idiomas no cartão, padrão para todos os idiomas relatados. | Inteiro | null |
api_domain | Define um domínio API personalizado para o cartão, por exemplo, usar serviços como Hakatime ou Wakapi | corda | wakatime.com |
display_format | Define o formato de exibição de estatísticas wakatime. Escolha time para exibir estatísticas baseadas no tempo ou percent para mostrar porcentagens. | enum | time |
disable_animations | Desative todas as animações no cartão. | booleano | false |
Os pinos extras do GitHub permitem que você prenda mais de 6 repositórios em seu perfil usando um perfil do GitHub ReadMe.
Yay! Você não está mais limitado a 6 repositórios fixados.
Copie cola este código no seu ReadMe e altere os links.
Endpoint: 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 )Use a opção Show_owner de consulta para incluir o nome de usuário do proprietário do repo
Os pinos Github GIST permitem que você prenda as gistas no seu perfil do GitHub usando um perfil do GitHub ReadMe.
Copie cola este código no seu ReadMe e altere os links.
Endpoint: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[ ![ Gist Card ] ( https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d )] ( https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/ )Use a opção Show_owner de consulta para incluir o nome de usuário do proprietário da essência
O cartão de linguagem principal mostra os idiomas mais usados de um usuário do Github.
Aviso
Por padrão, o cartão de idioma mostra os resultados do idioma apenas de repositórios públicos. Para incluir idiomas usados em repositórios privados, você deve implantar sua própria instância usando seu próprio token da API do GitHub.
Observação
Os principais idiomas não indicam o nível de habilidade do usuário ou algo assim; É uma métrica do GitHub determinar quais idiomas têm mais código no GitHub. É um novo recurso do Github-Readme-Stats.
Aviso
Este cartão mostra o uso do idioma apenas dentro de seus próprios repositórios não forçados, não dependendo de quem é o autor dos commits. Não inclui suas contribuições para outros repositórios de usuários/organizações. Atualmente, não há como obter esses dados da API do GitHub. Se você deseja que esse comportamento seja aprimorado, pode apoiar essa solicitação de recurso criada por @rickstaa dentro da comunidade do Github.
Aviso
Atualmente, este cartão mostra dados apenas sobre os 100 primeiros repositórios. Isso ocorre porque as limitações da API do GitHub que causam tempos de inatividade das instâncias públicas (ver #1471). No futuro, esse comportamento será aprimorado, liberando a ação do GitHub ou fornecendo variáveis de ambiente para as próprias instâncias do usuário.
Copie cola este código no seu ReadMe e altere os links.
Endpoint: 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 )Usamos o algoritmo a seguir para calcular as porcentagens de idiomas no cartão de idioma:
ranking_index = ( byte_count ^ size_weight ) * ( repo_count ^ count_weight ) Por padrão, apenas a contagem de bytes é usada para determinar as porcentagens de idiomas mostradas no cartão de idioma (ou seja, size_weight=1 e count_weight=0 ). Você pode, no entanto, usar o &size_weight= & &count_weight= opções para ponderar o cálculo do uso do idioma. Os valores devem ser números reais positivos. Mais detalhes sobre o algoritmo podem ser encontrados aqui.
&size_weight=1&count_weight=0 - (padrão) pedidos por contagem de bytes.&size_weight=0.5&count_weight=0.5 - (recomendado) usa bytes e contagem de repositórios para classificação&size_weight=0&count_weight=1 - Pedidos por contagem de repositórios ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5 ) Você pode usar o parâmetro &exclude_repo=repo1,repo2 para excluir repositórios individuais.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io ) Você pode usar &hide=language1,language2 para ocultar idiomas individuais.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html ) Você pode usar a opção &langs_count= para aumentar ou diminuir o número de idiomas mostrados no cartão. Os valores válidos são inteiros entre 1 e 20 (inclusive). Por padrão, foi definido como 5 para normal & donut e 6 para outros layouts.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8 ) Você pode usar a opção &layout=compact para alterar o design do cartão.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact ) Você pode usar a opção &layout=donut para alterar o design do cartão.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut )] ( https://github.com/anuraghazra/github-readme-stats ) Você pode usar a opção &layout=donut-vertical para alterar o design do cartão.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut-vertical )] ( https://github.com/anuraghazra/github-readme-stats ) Você pode usar a opção &layout=pie para alterar o design do cartão.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=pie )] ( https://github.com/anuraghazra/github-readme-stats ) Você pode usar a opção &hide_progress=true para ocultar as porcentagens e as barras de progresso (o layout será automaticamente definido como compact ).
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true )Aviso
Esteja ciente de que atualmente mostramos apenas dados de perfis de Wakatime que são públicos. Portanto, você deve garantir que ambos Display code time publicly e Display languages, editors, os, categories publicly estão ativadas publicamente.
Altere o ?username= valor para o seu nome de usuário wakatime.
[ ![ Harlok's WakaTime stats ] ( https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs )] ( https://github.com/anuraghazra/github-readme-stats )Escolha em qualquer um dos temas padrão
Por padrão, o Github não coloca os cartões lado a lado. Para fazer isso, você pode usar esta abordagem:
< 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 > Como a API do GitHub permite apenas 5K solicitações por hora, meu https://github-readme-stats.vercel.app/api stats.vercel.app/api poderia atingir o limitador de taxa. Se você o hospedar em seu próprio servidor vercel, não precisará se preocupar com nada. Clique no botão de implantação para começar!
Observação
Desde o número 58, devemos ser capazes de lidar com mais de 5k solicitações e ter menos problemas com o tempo de inatividade ?.
Observação
Se você estiver no plano de vercel pro (ou seja, o valor de maxDuration encontrado no vercel.json poderá ser aumentado quando sua instância de vercel com freqüência tempo de saída durante a solicitação do cartão. Você é aconselhado a manter esse valor inferior a 30 segundos para evitar o uso alto de memória.
Log in .Continue with GitHub .Add New... e selecione a opção Project .Continue with GitHub , pesquise o repositório Git necessário e importe -o clicando no botão Import . Como alternativa, você pode importar um repositório Git de terceiros usando o link Import Third-Party Git Repository -> na parte inferior da página.repo e user (isso permite que o acesso consulte o repositório privado e as estatísticas do usuário).PAT_1 (como mostrado).Aviso
Essa maneira de usar o GRS não é oficialmente suportada e foi adicionada para atender a alguns casos de uso específicos em que o vercel não pôde ser usado (por exemplo, #2341). O suporte a esse método, portanto, é limitado.
express à seção de dependências do package.jsongithub-leadme-stats/package.json
Linhas 54 a 61 em Ba7c2f8
npm i se necessário (configuração inicial)node express.js para iniciar o servidor ou definir o ponto de entrada para express.js no package.json se você estiver implantando em um serviço gerenciadogithub-leadme-stats/package.json
Linha 11 em Ba7c2f8
O Github ReadMe Stats contém várias variáveis de ambiente de vercel que podem ser usadas para remover as proteções de limite de taxa:
CACHE_SECONDS : Essa variável de ambiente tem precedência sobre nossos valores mínimos e máximos de cache e pode contornar esses valores para instâncias de vercel auto-hospedado.Consulte a documentação do Vercel sobre a adição dessas variáveis de ambiente à sua instância do Vercel.
Você pode manter o garfo e, portanto, sua instância privada de vercel atualizada com o upstream usando o botão Sync Fork do Github. Você também pode usar o pacote de tração criado por @wei para automatizar esse processo.
Eu abre quase tudo o que posso e tento responder a todos que precisam de ajuda para usar esses projetos. Obviamente, isso leva tempo. Você pode usar este serviço gratuitamente.
No entanto, se você estiver usando este projeto e está feliz com ele ou apenas deseja me incentivar a continuar criando coisas, existem algumas maneiras de fazê -lo:
Obrigado! ❤️
As contribuições são bem -vindas! <3
Feito com ❤️ e JavaScript.
