10 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 extra 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.
[](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"])
Mostrar íconos
Para habilitar los íconos, puedes utilizar show_icons=true como parámetro, de esta manera:
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:
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 de personalización:
| Option | type | description | Stats Card (default) | Repo Card (default) |
|---|---|---|---|---|
| title_color | hex color | color del título | 2f80ed | 2f80ed |
| text_color | hex color | color del contenido | 333 | 333 |
| icon_color | hex color | color del ícono | 4c71f2 | 586069 |
| bg_color | hex color | color de fondo | FFFEFE | FFFEFE |
| line_height | number | controla el line_height | 30 | N/A |
| hide_rank | boolean | oculta la clasificación | false | N/A |
| hide_title | boolean | oculta el título | false | N/A |
| hide_border | boolean | oculta el borde | false | N/A |
| show_owner | boolean | muestra el propietario | N/A | false |
| show_icons | boolean | muestra los íconos | false | N/A |
| theme | string | establece un tema incorporado | 'default' | 'default_repocard' |
Ejemplo
- Predeterminado
- Ocultando estadísticas específicas
- Mostrando íconos
- Temas
Elige uno de los temas predeterminados
- Personalizando la tarjeta de estadísticas
- Personalizando la tarjeta de repositorio
Pins extra de GitHub
Los pins extra de GitHub te permiten anclar más de 6 repositorios en tu perfil utilizando el archivo README.md.
¡Bien! Ya no estás limitado a 6 repositorios anclados.
Utilización
Copia y pega este código en tu README.md y cambia los links.
Endpoint: 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.
Pequeño consejo (alinear las tarjetas de repositorios)
Usualmente no serías capaz de alinear las imágenes una al lado de otra. Para lograrlo, puedes realizar esto:
<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.