mirror of
https://github.com/anuraghazra/github-readme-stats.git
synced 2024-12-15 06:04:17 +08:00
221 lines
10 KiB
Markdown
221 lines
10 KiB
Markdown
<p align="center">
|
|
<img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="Github Readme Stats" />
|
|
<h2 align="center">GitHub Readme Stats</h2>
|
|
<p align="center">¡Obtén tus estadísticas de GitHub generadas dinámicamente en tu README!</p>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/actions">
|
|
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues">
|
|
<img alt="Issues" src="https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/pulls">
|
|
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/anuraghazra/github-readme-stats?color=0088ff" />
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#ejemplo">Ve un ejemplo</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Reporta un bug</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Solicita una mejora</a>
|
|
</p>
|
|
</p>
|
|
<p align="center">¿Te gusta este proyecto? ¡Por favor considera <a href="https://www.paypal.me/anuraghazra">donar</a> para ayudar a mejorarlo!
|
|
|
|
# Características
|
|
|
|
- [Tarjeta de estadísticas de GitHub](#tarjeta-de-estadísticas-de-github)
|
|
- [Pins extra de GitHub](#pins-extra-de-github)
|
|
- [Temas](#temas)
|
|
- [Personalización](#personalización)
|
|
- [Despliega por tu cuenta](#despliega-tu-propia-instancia-de-vercel)
|
|
|
|
# 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.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
_Nota: las clasificaciones se calculan basándose en las estadísticas del usuario. Ve [src/calculateRank.js](./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"]`
|
|
|
|
```md
|
|
![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:
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Temas
|
|
|
|
Puedes personalizar el aspecto de la tarjeta sin realizar ninguna [personalización manual](#personalización) con los temas incorporados.
|
|
|
|
Utiliza el parámetro `?theme=THEME_NAME`, de esta manera:
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
#### Todos los temas incorporados
|
|
|
|
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
|
|
|
|
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="Github Readme Stat Themes" width="600px"/>
|
|
|
|
Puedes ver una vista previa de [todos los temas disponibles](./themes/README.md) o ver el [archivo de configuración](./themes/index.js) 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
|
|
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"])
|
|
|
|
- Mostrando íconos
|
|
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)
|
|
|
|
- Temas
|
|
|
|
Elige uno de los [temas predeterminados](#temas)
|
|
|
|
|
|
|
|
- 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`
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Ejemplo
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
Utiliza la variable [show_owner](#customización) para incluir el nombre de usuario del propietario del repositorio.
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
### 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:
|
|
|
|
```md
|
|
<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](https://github.com/anuraghazra/github-readme-stats/pull/58) podríamos manejar más de 5 mil peticiones sin tener ningún problema con el downtime :D
|
|
|
|
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
<details>
|
|
<summary>Guía para comenzar en Vercel</summary>
|
|
|
|
1. Ve a [vercel.com](https://vercel.com/)
|
|
1. Clickea en `Log in`
|
|
|
|
1. Inicia sesión con GitHub presionando `Continue with GitHub`
|
|
|
|
1. Permite el acceso a todos los repositorios (si se te pregunta)
|
|
1. Haz un Fork de este repositorio
|
|
1. Dirígete de nuevo a tu [Vercel dashboard](https://vercel.com/dashboard)
|
|
1. Selecciona `Import Project`
|
|
|
|
1. Selecciona `Import Git Repository`
|
|
|
|
1. 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í](https://github.com/settings/tokens/new) (mantén todo como está, simplemente asígnale un nombre, puede ser cualquiera que desees)
|
|
|
|
1. Clickea "Deploy" y ya está listo. ¡Ve tus dominios para usar la API!
|
|
|
|
</details>
|
|
|
|
## :sparkling_heart: 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 :rocket:
|
|
- [](https://www.paypal.me/anuraghazra) - Puedes hacerme una única donación a través de PayPal. Probablemente me compraré un ~~café~~ té. :tea:
|
|
|
|
¡Gracias! :heart:
|
|
|
|
---
|
|
|
|
¡Las contribuciones son bienvenidas! <3
|
|
|
|
Hecho con :heart: y JavaScript.
|