20 KiB
GitHub Readme Stats
¡Obtén tus estadísticas de GitHub generadas dinámicamente en tu README!
Ver un ejemplo · Reportar un bug · Solicitar una mejora
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어 . Nederlands . Türkçe . नेपाली
¿Te gusta este proyecto? ¡Por favor, considera donar para ayudar a mejorarlo!
Características
- Tarjeta de estadísticas de GitHub
- Pines adicionales de GitHub
- Tarjeta de Lenguajes Principales
- Estadísticas de la semana de Wakatime
Tarjeta de estadísticas de GitHub
Copia y pega esto en el contenido de tu README.md y listo. ¡Simple!
Cambia el valor de ?username=
al nombre de tu usuario de GitHub.
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
Nota: Los rangos disponibles son S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%) y B+ (todos). Los valores se calculan utilizando la función de distribución acumulada utilizando commits, contribuciones, issues, estrellas, pull request, seguidores y repositorios propios. Puedes investigar más sobre la implementación en src/calculateRank.js.
Ocultar estadísticas individualmente
Para ocultar alguna estadística específica, puedes utilizar el parámetro ?hide=
con los elementos que quieras ocultar separados por comas.
Opciones:
&hide=stars,commits,prs,issues,contribs
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
Agregar contribuciones privadas al total de commits contados
Puedes agregar el recuento de todas sus contribuciones privadas al recuento total de commits utilizando el parámetro ?count_private=true
.
Nota: Si estás desplegando este proyecto tú mismo, las contribuciones privadas se contarán de manera predeterminada; de lo contrario, deberás elegir compartir el recuento de sus contribuciones privadas.
Opciones:
&count_private=true
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
Mostrar íconos
Para habilitar los íconos, puedes utilizar show_icons=true
como parámetro, de esta manera:
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
Temas
Puedes personalizar el aspecto de la tarjeta sin realizar ninguna personalización manual con los temas incorporados.
Utiliza el parámetro ?theme=THEME_NAME
, de esta manera:
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
Todos los temas incorporados
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
Puedes ver una vista previa de todos los temas disponibles o ver el archivo de configuración del tema y también puedes contribuir con nuevos temas si lo deseas :D
Personalización
Puedes personalizar el aspecto de tu Tarjeta de Estadísticas
o Tarjeta de Repo
de la manera que desees con los parámetros URL.
Opciones Comunes:
title_color
- Color del título (hex color)text_color
- Color del contenido (hex color)icon_color
- Color de icono si esta disponible (hex color)bg_color
- Color de fondo (hex color)hide_border
- Oculta el borde de la tarjeta (booleano)theme
- Nombre del tema, elige uno de todos los temas disponiblecache_seconds
- Cache (min: 14400, max: 86400)locale
- configurar el idioma en la tarjeta (p.ej. cn, de, es, etc.)
Gradiente en bg_color
Puedes pasar mútliples valores separados por coma en la opción bg_color
para dibujar un gradiente, el formato del gradiente es:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Nota sobre la caché: las tarjetas de Repo tienen un caché predeterminado de 4 horas (14400 segundos) si el recuento forks y el recuento de estrellas es inferior a 1k; de lo contrario, son 2 horas (7200 segundos). También ten en cuenta que la caché está sujeta a un mínimo de 2 horas y un máximo de 24 horas
Opciones exclusivas de la Tarjeta de Estadísticas:
hide
- Oculta de las estadísticas los elementos especificados (valores separados por comas)hide_title
- (booleano)hide_rank
- (booleano)show_icons
- (booleano)include_all_commits
- Cuenta el total de commits en lugar de solo los commits del año actual (boolean)count_private
- Cuenta los commits privadas (boolean)line_height
- Establece el alto de línea entre texto (número)custom_title
- Establece un título personalizado- [
disable_animations
] - Desactiva todas las animaciones (booleano)
Opciones exclusivas de la Tarjeta de Repo:
show_owner
- Mostrar el nombre del propietario del repositorio (booleano)
Opciones exclusivas de la Tarjeta de Lenguajes:
hide
- Oculta de la tarjeta los lenguajes especificados (valores separados por comas)hide_title
- (booleano)layout
- Cambiar entre los cinco diseños disponiblesnormal
&compact
&donut
&donut-vertical
&pie
card_width
- Establece el ancho de la tarjeta manualmente (número)langs_count
- Muestra más lenguajes en la tarjeta, entre 1-10, por defecto 5 (número)exclude_repo
- Excluye los repositorios especificados (valores separados por comas)custom_title
- Establece un título personalizado
⚠️ Importante: Los nombres de los lenguajes deben estar codificados para URLs, como se especifica en Código porciento (es decir:
c++
debería convertirse enc%2B%2B
,jupyter notebook
debería convertirse enjupyter%20notebook
, etc.)
Opciones exclusivas de la Tarjeta de Wakatime:
hide_title
- (booleano)line_height
- Establece el alto de línea entre texto (número)hide_progress
- Oculta la barra de progreso y el porcentaje (booleano)custom_title
- Establece un título personalizadolayout
- Cambia entre los dos diseños disponiblesdefault
&compact
langs_count
- Limita el número de idiomas que aparecen en el mapaapi_domain
- Establece un dominio de API personalizado para la tarjeta
Pines adicionales de GitHub
Los pines adicionales de GitHub le permiten fijar más de 6 repositorios en su perfil utilizando un perfil readme de GitHub.
¡Yey! Ya no está limitado a 6 repositorios pinneados.
Utilización
Copia y pegua este código en tu Readme y cambia los enlaces.
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)
Ejemplo
Utiliza la variable show_owner para incluir el nombre de usuario del propietario del repositorio.
Tarjeta de Lenguajes Principales
La tarjeta de lenguajes principales muestra los lenguajes principales del usuario de GitHub que se han utilizado principalmente.
NOTA: los lenguajes principales no indican mi nivel de habilidad o algo así, es una métrica de GitHub de los lenguajes que tengo más código en GitHub. Es una nueva característica de github-readme-stats
Utilización
Copia y pegua este código en tu Readme y cambia los enlaces.
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)
Excluir repositorios individualmente
Puedes usar el parámetro ?exclude_repo=repo1,repo2
para ocultar repositorios individualmente.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io)](https://github.com/anuraghazra/github-readme-stats)
Ocultar lenguajes individualmente
Puedes usar el parámetro ?hide=language1,language2
para ocultar lenguajes individualmente.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
Mostrar más lenguajes
Puedes usar el paramétro &langs_count=
para incrementar o decrementar el número de lenguajes mostrados en la tarjeta. Los valores admitidos son los números enteros entre 1 y 10 (inclusive), y el valor por defecto es 5.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8)](https://github.com/anuraghazra/github-readme-stats)
Diseño Compacto de Tarjeta de Lenguaje
Puedes usar la opción & layout = compact
para cambiar el diseño de la tarjeta.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
Ejemplo
- Diseño compacto
Estadísticas de la semana de Wakatime
cambia el valor del parámetro ?username=
a tu username en Wakatime.
[![Harlok's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats)
Ejemplo
- Diseño compacto
Todos los ejemplos
- Por defecto
- Ocultando ciertas estadísticas
- Mostrando íconos
- Incluyendo todos los commits
- Temas
Escoja cualquiera de los temas por defecto
- Gradiente
- Personalizando Tarjeta de Estadísticas
- Estableciendo Idioma de la tarjeta
- Personalizando Tarjeta de Repo
- Lenguajes Top
- Tarjeta de Wakatime
Consejo rápido (para alinear las tarjetas de repositorio)
Por lo general, no podrás acomodar las imágenes una al lado de la otra. Para hacerlo, puede usar este enfoque:
<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>
Despliega tu propia instancia de Vercel
Échale un vistazo a este tutorial paso a paso de @codeSTACKr
Desde que la API de GitHub permite solo 5k peticiones por hora, es posible que mi https://github-readme-stats.vercel.app/api
pueda llegar al límite. Si lo alojas en tu propio servidor de Vercel, no tendrás que preocuparte de nada. ¡Clickea en el botón "Deploy" para comenzar!
NOTA: Debido a #58 podríamos manejar más de 5k peticiones sin tener ningún problema con el downtime :D
Guía para comenzar en Vercel
- Ve a vercel.com
- Clickea en
Log in
- Inicia sesión con GitHub presionando
Continue with GitHub
- Permite el acceso a todos los repositorios (si se te pregunta)
- Haz un Fork de este repositorio
- Dirígete de nuevo a tu Vercel dashboard
- Selecciona
Import Project
- Selecciona
Import Git Repository
- Selecciona "root" y matén todo como está, simplemente añade tu variable de entorno llamada PAT_1 (como se muestra), la cual contendrá un token de acceso personal (PAT), el cual puedes crear fácilmente aquí (mantén todo como está, simplemente asígnale un nombre, puede ser cualquiera que desees)
- Clickea "Deploy" y ya está listo. ¡Ve tus dominios para usar la API!
💖 Apoya al proyecto
Casi todos mis proyectos son de código abierto e intento responder a todos los usuarios que necesiten ayuda con alguno de estos proyectos. Obviamente, esto toma tiempo. Puedes usar este servicio gratis.
No obstante, si estás utilizando este proyecto y estás feliz con él o simplemente quieres animarme a que siga creando cosas, aquí tienes algunas maneras de hacerlo:
- Darme créditos cuando estés utilizando github-readme-stats en tu README, añadiendo un link a este repositorio :D
- Dándole una estrella y compartiendo el proyecto 🚀
- - Puedes hacerme una única donación a través de PayPal. Probablemente me compraré un
cafété. 🍵
¡Gracias! ❤️
¡Las contribuciones son bienvenidas! <3
Hecho con ❤️ y JavaScript.