14 KiB
GitHub Readme Stats
Adicione suas estatísticas no GitHub geradas dinamicamente em seus readmes!
Ver demonstração · Reportar erros · Solicitar recursos
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어
Gostou do projeto? Por favor considere fazer uma doação para ajudar a melhorá-lo!
Características
- Cartão de estatísticas do GitHub
- Pins extras do GitHub
- Cartão de principais linguagens de programação
- Temas
- Personalização
- Faça suas próprias implantações
Cartão de estatísticas do GitHub
Copie e cole isso no seu conteúdo de remarcação e é isso. Simples!
Mude o valor de ?username=
para o seu nome de usuário no GitHub.
[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
Nota: As classificações são baseadas nas estatísticas do usuário, veja src/calculateRank.js
Ocultando estatísticas específicas
Para ocultar estatísticas individualmente, você pode passar um parâmetro de consulta ?hide=
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)
Adicionando contagem de contribuições privadas à contagem total de commits
Adicione a contagem de todas as suas contribuições privadas à contagem total de confirmações usando o parâmetro de consulta ?count_private=true
.
Nota: Se você estiver implantando este projeto, as contribuições privadas serão contadas por padrão; caso contrário, você precisará compartilhar suas contagens de contribuições privadas.
Opções:
&count_private=true
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
Exibindo ícones
Para habilitar ícones, basta utilizar o parâmetro show_icons=true
na sua requisição, da seguinte forma:
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
Temas
Com temas predefinidos, pode personalizar a aparência dos cartões sem precisar fazer nenhuma configuração manual.
Utilize o parâmetro ?theme=THEME_NAME
, da seguinte forma:
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
Todos os temas predefinidos :
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
Visualize todos o temas disponíveis ou o arquivo de configuração de tema, além de também poder contribuir com novos temas, se desejar :D
Personalização
Personalize a aparência do seu Stats Card
ou Repo Card
da maneira que desejar com os parâmetros de URL.
Opções comuns
title_color
- Cor do título do cartão (hex color)text_color
- Cor de texto do conteúdo (hex color)icon_color
- Cor dos ícones (se disponível) (hex color)bg_color
- Cor de fundo do cartão (hex color)theme
- Nome do tema, escolha em todos os temas disponíveiscache_seconds
- Defina o cabeçalho do cache manualmente (min: 1800, max: 86400)
Nota sobre o cache: Cartões de repositório tem um cache padrão de 30 minutos (1800 segundos), se o número a contagem de forks e contagem de estrelas é menor que 1 mil o padrão é 2 horas (7200). Note também que o cache é limitado a um mínimo de 30 minutos e um máximo de 24 horas.
Opções exclusivas do cartão de estatísticas:
hide
- Oculta itens específicos das estatísticas (Valores separados por vírgulas)hide_title
- Ocutar o título (boolean)hide_rank
- Ocultar a classificação (boolean)show_icons
- Mostrar ícones (boolean)include_all_commits
- Contabiliza todos os commits ao invés de apenas os atual ano (boolean)count_private
- Contabiliza commits privados (boolean)line_height
- Define a altura do espaçamento entre o texto (number)
Opções exclusivas do cartão de repositórios:
show_owner
- Exibir o nome da pessoa a quem o repositório pertence (boolean)
Opções exclusivas do cartão de linguagens:
hide
- Oculta linguagens específicas (Valores separados por vírgulas)hide_title
- Oculta o título (boolean)layout
- Alterna entre os dois layouts disponíveisdefault
&compact
card_width
- Define a largura do cartão manualmente (number)
⚠️ Importante:
Nomes de linguagens devem ser uma sequência escapada de URI, como específicado em Codificação por cento
(Isso é:c++
deve se tornarc%2B%2B
,jupyter notebook
deve se tornarjupyter%20notebook
, etc.)
Pins extras do GitHub
Os Pins extras do GitHub permitem fixar mais de 6 repositórios no seu perfil usando um perfil README.me do GitHub.
Uhu! Você não está mais limitado a 6 repositórios fixados.
Utilização
Copie e cole esse código no seu README.md e altere os atributos.
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)
Demonstração
Utilize a variável show_owner para incluir o nome de usuário do proprietária do repositório
Cartão de principais linguagens de programação
Exibe uma métrica de linguagens de programação mais usadas pelo usuário do GitHub.
Nota: As principais linguagens de programação não fazem declarações sobre habilidades pessoais ou similares, é apenas uma figura-chave com base nas estatísticas do GitHub do usuário indicando a frequência com que cada uma foi utilizada.
Utilização
Copie e cole esse código no seu README.md e altere os atributos.
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)
Ocultar linguagens individualmente
Utilize o parâmetro ?hide=language1,language2
para ocultar linguagens específicas.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
Layout de cartão de linguagens compacto
Utilize a opção &layout=compact
para mudar o layout do cartão.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
Demonstração
- Layout compacto
Todas as demonstrações
- Padronizado
- Ocultando estatísticas específicas
- Mostrando ícones
- Incluir todos os commits
- Temas
Escolha entre um dos temas predefinidos
- Personalizando o cartão de estatísticas
- Customizando o cartão de repositório
- Principais linguagens
Dica (Alinhandos os cartões de repositório)
Por padrão, você não poderá organizar as imagens lado a lado. Para fazer isso, você pode usar a seguinte abordagem:
<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>
Implante em sua própria instância do Vercel
Check Out Step By Step Video Tutorial By @codeSTACKr
Como a API do GitHub permite apenas 5 mil solicitações por hora, é possível que minha https://github-readme-stats.vercel.app/api
atinja a cota limite. Se hospedar em seu próprio servidor Vercel, não precisará se preocupar com nada. Clique no botão de implantação para começar!
Nota: Desde #58 há possibilidade de lidar com mais de 5 mil chamadas por hora, sem interrupções :D
Guia de configuração do Vercel
- Acesse vercel.com
- Clique em
Login
- Acesse com o GitHub clicando em
Continue with GitHub
- Entre no GitHub e permita acesso a todos os repositórios, se solicitado
- Faça Fork neste repositório
- Volte ao seu painel principal do Vercel
- Selecione
Import Project
- Selecione
Import Git Repository
- Selecione a raiz e mantenha tudo como está, basta adicionar sua variável de ambiente chamada PAT_1 (que será exibida), que conterá um token de acesso pessoal (PAT), que você pode criar facilmente aqui (deixe tudo como está, apenas dê um nome, que pode ser o que você quiser)
- Clique em
deploy
e já estará tudo pronto. Veja seus domínios para usar a API!
💖 Apoie o projeto
Disponibilizo como código aberto quase tudo o que posso e tento responder a todos que precisam de ajuda para utilizar esses projetos. Claro, isso demanda tempo. Utilize este serviço gratuitamente.
No entanto, se você utilizar este projeto e estiver satisfeito com ele, ou apenas quiser me encorajar a continuar criando coisas, existem algumas formas fazê-lo:
- Dando os devidos créditos ao usar github-readme-stats no seu README.me, adicionando uma referência ao projeto :D
- Dando uma estrela (Starring) e compartilhando o projeto 🚀
- - Você pode fazer doações únicas via PayPal. Provavelmente vou comprar um
caféchá. 🍵
Obrigado! ❤️
Contribuições são bem-vindas! <3
Feito com ❤️ e JavaScript.