14 KiB
GitHub Readme Stats
¡Obtén tus estadísticas de GitHub generadas dinámicamente en tu README!
Ve un ejemplo · Reporta un bug · Solicita una mejora
¿Te gusta este proyecto? ¡Por favor considera donar para ayudar a mejorarlo!
Características
- Tarjeta de estadísticas de GitHub
- Pins adicionales de GitHub
- Temas
- Personalización
- Despliega por tu cuenta
Tarjeta de estadísticas de GitHub
Copia y pega esto en el contenido de tu README.md y listo. ¡Simple!
Cambia el valor ?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: las clasificaciones se calculan basándose en las estadísticas del usuario. Ve src/calculateRank.js.
Ocultar estadísticas individualmente
Para ocultar alguna estadística específica, puedes utilizar el parámetro ?hide=
con un arreglo de items que quieras ocultar.
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
Puede agregar el recuento de todas sus contribuciones privadas al recuento total de confirmaciones utilizando el parámetro de consulta ?count_private=true
.
Nota: Si está desplegando este proyecto usted mismo, las contribuciones privadas se contarán de manera predeterminada; de lo contrario, deberá elegir compartir sus recuentos de 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 Stats Card
o Repo Card
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)theme
- Nombre del tema, elige uno de todos los temas disponiblecache_seconds
- Cache (min: 1800, max: 86400)
Nota sobre la caché: las tarjetas de Repo tienen un caché predeterminado de 30 minutos (1800 segundos) si el recuento forks y el recuento de estrellas es inferior a 1k; de lo contrario, son 2 horas (7200). También tenga en cuenta que el caché está sujeto a un mínimo de 30 minutos y un máximo de 24 horas
Opciones exclusivas de la tarjeta de estadísticas:
hide
- Ocultar los elementos especificados de las estadísticas _ (valores separados por comas) _hide_title
- (boolean)hide_rank
- (boolean)show_icons
- (boolean)include_all_commits
- Cuente los commits totales 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 (number)
Opciones exclusivas de la tarjeta Repo:
show_owner
- Mostrar el nombre del propietario del repositorio (boolean)
Opciones exclusivas de la tarjeta de lenguajes:
hide
- Ocultar los lenguajes especificados de la tarjeta (valores separados por comas)hide_title
- (boolean)layout
- Cambiar entre dos diseños disponiblesdefault
&compact
card_width
- Establecer el ancho de la tarjeta manualmente (number)
⚠️ Importante:
Los nombres de los idiomas deben tener escape de uri, como se especifica en Código porciento
(es decir:c++
debería convertirse enc%2B%2B
,jupyter notebook
debería convertirse enjupyter%20notebook
, etc.)
Pines adicionales de GitHub
Los pines adicionales de GitHub le permiten fijar más de 6 repositorios en su perfil utilizando un readme de perfil de GitHub.
Yey! Ya no está limitado a 6 repositorios anclados.
Utilización
Copie y pegue este código en su archivo Léame y cambie 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
Copie y pegue este código en su readme y cambie 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)
Ocultar lenguajes individuales
Puede usar el parámetro ? Hide = language1, language2
para ocultar lenguajes individuales.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
Diseño de tarjeta de lenguaje compacta
Puede 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
Todos los ejemplos
- Por Defecto
- Ocultar estadísticas específicas
- Mostrando iconos
- Incluir todos los Commits
- Temas
Elija entre cualquiera de los temas predeterminados
- Personalizando tarjeta de estadísticas
- Personalizar la tarjeta de repositorio
- Lenguajes Principales
Consejo rápido (alinee las tarjetas de repositorio)
Por lo general, no podrá diseñar 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="left" 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="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
Despliega tu propia instancia de vercel
Desde que la API de GitHub permite solo 5 mil 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 esto #58 podríamos manejar más de 5 mil 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 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 (starring) 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.