github readme stats
1.0.0
¡Obtenga estadísticas de GitHub generadas dinámicamente en sus lectores!
Ver demostración · Informe de error · Función de solicitud · Preguntas frecuentes · Haga preguntas
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어 · Nederlands · नेपाली · Türkçe
Tenga en cuenta que las traducciones de documentación pueden estar desactualizadas; Intente usar la documentación en inglés si es posible.
¿Te encanta el proyecto? ¡Considere donar para ayudarlo a mejorar!
¿Está considerando apoyar el proyecto donándome? Por favor no lo hagas !!!
India ha sufrido recientemente uno de los accidentes de trenes más devastadores, y su ayuda será inmensamente valiosa para las personas afectadas por esta tragedia.
Visite este enlace y haga una pequeña donación para ayudar a las personas necesitadas. Una pequeña donación es muy útil. ❤️
Importante
Dado que la API de GitHub solo permite solicitudes de 5k por hora por cuenta de usuario, la instancia pública de Vercel alojada en https://github-readme-stats.vercel.app/api podría alcanzar el limitador de tarifa (ver #1471). Utilizamos el almacenamiento en caché para evitar que esto suceda (ver https://github.com/anuraghazra/github-readme-stats#common-options). Puede desactivar estas protecciones de límite de tarifas implementando su propia instancia de Vercel.
Importante
Somos un equipo pequeño y, para priorizar, confiamos en votos Utilizamos el tablero de problemas principales para rastrear la demanda de la comunidad (ver #1935). No dude en votar los problemas y extraer las solicitudes que le interesan. Trabajaremos primero en el más votado.
Copie y pegue esto en su Markdown, y eso es todo. ¡Simple!
Cambie el ?username= valor a su nombre de usuario GitHub.
[ ![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra )] ( https://github.com/anuraghazra/github-readme-stats ) Advertencia
Por defecto, la tarjeta STATS solo muestra estadísticas como estrellas, compromisos y solicitudes de repositorios públicos. Para mostrar estadísticas privadas en la tarjeta de estadísticas, debe implementar su propia instancia utilizando su propio token de la API GitHub.
Nota
Los rangos disponibles son S (1%superior), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) y C (todos). Este esquema de clasificación se basa en el sistema de calificación académica japonesa. El percentil global se calcula como una suma ponderada de percentiles para cada estadística (número de compromisos, solicitudes de extracción, revisiones, problemas, estrellas y seguidores), en función de la función de distribución acumulada de las distribuciones exponenciales y logarítmicas normales. La implementación se puede investigar en SRC/Calculaterank.js. El círculo alrededor del rango muestra 100 menos el percentil global.
Puede pasar un parámetro de consulta &hide= para ocultar cualquier estadísticas específicas con valores 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 ) Puede pasar un parámetro de consulta &show= para mostrar cualquier estadísticas adicionales específicas con valores separados por comas.
Opciones:
&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage ) Para habilitar los iconos, puede pasar &show_icons=true en el parámetro de consulta, como así:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true )Con temas incorporados, puede personalizar el aspecto de la tarjeta sin realizar ninguna personalización manual.
Use &theme=THEME_NAME parámetro como así:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical ) Las estadísticas de lectura de GitHub vienen con varios temas incorporados (por ejemplo, dark , radical , merko , gruvbox , tokyonight , onedark , cobalt , synthwave , highcontrast , dracula ).
Puede ver una vista previa de todos los temas disponibles o consultar el archivo de configuración del tema. Tenga en cuenta que detuvimos la adición de nuevos temas para disminuir los esfuerzos de mantenimiento; Todas las solicitudes de extracción relacionadas con nuevos temas estarán cerrados.
Dado que Github volverá a cargar las tarjetas y las servirá de su CDN, no podemos inferir el tema del navegador/GitHub en el lado del servidor. Sin embargo, hay cuatro métodos que puede usar para crear temas de dinámica en el lado del cliente.
Hemos incluido un tema transparent que tiene un fondo transparente. Este tema está optimizado para verse bien en los temas predeterminados oscuros y ligeros de GitHub. Puede habilitar este tema usando el parámetro &theme=transparent como así:
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=transparent ) Puede usar el parámetro bg_color para hacer que cualquiera de los temas disponibles sea transparente. Esto se hace configurando el bg_color en un color con un canal alfa transparente (es decir, bg_color=00000000 ):
![ Anurag's GitHub stats ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&bg_color=00000000 ) Puede usar las etiquetas de contexto del tema de GitHub para cambiar el tema en función del tema GitHub de usuario automáticamente. Esto se hace agregando #gh-dark-mode-only o #gh-light-mode-only hasta el final de una URL de imagen. Esta etiqueta definirá si la imagen especificada en el markdown solo se muestra a los espectadores usando un tema de Github de luz o oscuro:
[ ![ Anurag's GitHub stats-Dark ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only )] ( https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only )
[ ![ Anurag's GitHub stats-Light ] ( https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only )] ( https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only ) Puede usar la nueva función de medios de GitHub en HTML para especificar si muestra imágenes para temas claros o oscuros. Esto se realiza utilizando el elemento HTML <picture> en combinación con la función de medios prefers-color-scheme .
< picture >
< source
srcset =" https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark "
media =" (prefers-color-scheme: dark) "
/>
< source
srcset =" https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true "
media =" (prefers-color-scheme: light), (prefers-color-scheme: no-preference) "
/>
< img src =" https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true " />
</ picture >Puede personalizar la apariencia de todas sus tarjetas, sin embargo, lo desee con los parámetros de URL.
| Nombre | Descripción | Tipo | Valor predeterminado |
|---|---|---|---|
title_color | Color del título de la tarjeta. | cadena (color hexadecimal) | 2f80ed |
text_color | Color de texto del cuerpo. | cadena (color hexadecimal) | 434d58 |
icon_color | Color de iconos si está disponible. | cadena (color hexadecimal) | 4c71f2 |
border_color | Color del borde de la tarjeta. No se aplica cuando hide_border está habilitado. | cadena (color hexadecimal) | e4e2e2 |
bg_color | Color de fondo de la tarjeta. | cadena (color hexadecimal o un gradiente en forma de ángulo, inicio, final ) | fffefe |
hide_border | Esconde el borde de la tarjeta. | booleano | false |
theme | Nombre del tema, elija entre todos los temas disponibles. | enumer | default |
cache_seconds | Establece el encabezado de caché manualmente (min: 21600, máx.: 86400). | entero | 21600 |
locale | Establece el idioma en la tarjeta, puede verificar la lista completa de los lugares disponibles aquí. | enumer | en |
border_radius | Reduce de esquina en la tarjeta. | número | 4.5 |
Advertencia
Usamos almacenamiento en caché para disminuir la carga en nuestros servidores (ver #1471 (comentario)). Nuestras tarjetas tienen un caché predeterminado de 6 horas (21600 segundos). Además, tenga en cuenta que el caché se sujeta a un mínimo de 6 horas y un máximo de 24 horas. Si desea que los datos en su tarjeta de estadística se actualicen con más frecuencia, puede implementar su propia instancia y establecer la variable de entorno CACHE_SECONDS en un valor de su elección.
Puede proporcionar múltiples valores separados por comas en la opción BG_Color para representar un gradiente con el siguiente formato:
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Aquí hay una lista de todos los lugares disponibles:
|
|
|
Si no apoyamos su idioma, ¡considere contribuir! Puede encontrar más información sobre cómo hacerlo en nuestras pautas contribuyentes.
| Nombre | Descripción | Tipo | Valor predeterminado |
|---|---|---|---|
hide | Oculta los elementos especificados de las estadísticas. | Cadena (valores separados por comas) | null |
hide_title | Oculta el título de su tarjeta de estadísticas. | booleano | false |
card_width | Establece el ancho de la tarjeta manualmente. | número | 500px (approx.) |
hide_rank | Oculta el rango y cambia de tamaño automáticamente el ancho de la tarjeta. | booleano | false |
rank_icon | Muestra un icono de rango alternativo (es decir, github , percentile o default ). | enumer | default |
show_icons | Muestra íconos cerca de todas las estadísticas. | booleano | false |
include_all_commits | Cuente Total Commits en lugar de solo el año en curso. | booleano | false |
line_height | Establece la altura de la línea entre el texto. | entero | 25 |
exclude_repo | Excluye repositorios especificados. | Cadena (valores separados por comas) | null |
custom_title | Establece un título personalizado para la tarjeta. | cadena | <username> GitHub Stats |
text_bold | Utiliza texto en negrita. | booleano | true |
disable_animations | Desactiva todas las animaciones en la tarjeta. | booleano | false |
ring_color | Color del círculo de rango. | cadena (color hexadecimal) | 2f80ed |
number_format | Cambios entre dos formatos disponibles para mostrar los valores de la tarjeta short (es decir, 6.6k ) y long (es decir, 6626 ). | enumer | short |
show | Muestra elementos adicionales en la tarjeta STATS (es decir, reviews , discussions_started , discussions_answered , prs_merged o prs_merged_percentage ). | Cadena (valores separados por comas) | null |
Nota
Cuando hide_rank = true , el ancho de la tarjeta mínima es 270 PX + la longitud del título y el relleno.
| Nombre | Descripción | Tipo | Valor predeterminado |
|---|---|---|---|
show_owner | Muestra el nombre del propietario del repositorio. | booleano | false |
description_lines_count | Establezca manualmente el número de líneas para la descripción. El valor especificado se sujetará entre 1 y 3. Si este parámetro no se especifica, el número de líneas se ajustará automáticamente de acuerdo con la longitud real de la descripción. | número | null |
| Nombre | Descripción | Tipo | Valor predeterminado |
|---|---|---|---|
show_owner | Muestra el nombre del propietario de la esencia. | booleano | false |
| Nombre | Descripción | Tipo | Valor predeterminado |
|---|---|---|---|
hide | Oculta los idiomas especificados de la tarjeta. | Cadena (valores separados por comas) | null |
hide_title | Oculta el título de tu tarjeta. | booleano | false |
layout | Cambios entre cinco diseños disponibles normal & compact & donut & donut-vertical & pie . | enumer | normal |
card_width | Establece el ancho de la tarjeta manualmente. | número | 300 |
langs_count | Muestra más idiomas en la tarjeta, entre 1-20. | entero | 5 para normal y donut , 6 para otros diseños |
exclude_repo | Excluye repositorios especificados. | Cadena (valores separados por comas) | null |
custom_title | Establece un título personalizado para la tarjeta. | cadena | Most Used Languages |
disable_animations | Desactiva todas las animaciones en la tarjeta. | booleano | false |
hide_progress | Utiliza la opción de diseño compacto, oculta los porcentajes y elimina las barras. | booleano | false |
size_weight | Configuración del algoritmo de estadísticas del lenguaje (ver algoritmo de estadísticas del idioma). | entero | 1 |
count_weight | Configuración del algoritmo de estadísticas del lenguaje (ver algoritmo de estadísticas del idioma). | entero | 0 |
Advertencia
Los nombres de idiomas deben estar enviados por URI, como se especifica en el porcentaje de codificación (es decir: c++ debe convertirse en c%2B%2B , jupyter notebook debería convertirse en jupyter%20notebook , etc.) Puede usar urlencoder.org para ayudarlo a hacerlo automáticamente.
| Nombre | Descripción | Tipo | Valor predeterminado |
|---|---|---|---|
hide | Oculta los idiomas especificados de la tarjeta. | Cadena (valores separados por comas) | null |
hide_title | Oculta el título de tu tarjeta. | booleano | false |
line_height | Establece la altura de la línea entre el texto. | entero | 25 |
hide_progress | Oculta la barra de progreso y el porcentaje. | booleano | false |
custom_title | Establece un título personalizado para la tarjeta. | cadena | WakaTime Stats |
layout | Cambios entre dos diseños disponibles default y compact . | enumer | default |
langs_count | Limita el número de idiomas en la tarjeta, predeterminados a todos los idiomas informados. | entero | null |
api_domain | Establece un dominio API personalizado para la tarjeta, por ejemplo, para usar servicios como Hakatime o Wakapi | cadena | wakatime.com |
display_format | Establece el formato de visualización de estadísticas de Wakatime. Elija time para mostrar estadísticas o percent basadas en el tiempo para mostrar porcentajes. | enumer | time |
disable_animations | Desactiva todas las animaciones en la tarjeta. | booleano | false |
Los alfileres adicionales de GitHub le permiten fijar más de 6 repositorios en su perfil utilizando un perfil GitHub ReadMe.
¡Hurra! Ya no estás limitado a 6 repositorios fijados.
Copie Paste este código en su ReadMe 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 )Use la opción de consulta Show_owner para incluir el nombre de usuario del propietario del repositorio
Los pasadores GitHub Gist te permiten fijar los Gists en tu perfil GitHub usando un perfil de lectura GitHub.
Copie Paste este código en su ReadMe y cambie los enlaces.
Punto final: api/gist?id=bbfce31e0217a3689c8d961a356cb10d
[ ![ Gist Card ] ( https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d )] ( https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/ )Use la opción de consulta Show_owner para incluir el nombre de usuario del propietario de GIST
La tarjeta Top Languages muestra los idiomas de uso más frecuente de los usuarios de GitHub.
Advertencia
Por defecto, la tarjeta del idioma muestra los resultados del idioma solo de los repositorios públicos. Para incluir idiomas utilizados en repositorios privados, debe implementar su propia instancia utilizando su propio token de la API GitHub.
Nota
Top Languages no indica el nivel de habilidad del usuario ni nada de eso; Es una métrica de GitHub para determinar qué idiomas tienen la mayor cantidad de código en GitHub. Es una nueva característica de GitHub-Readme-Stats.
Advertencia
Esta tarjeta muestra el uso del lenguaje solo dentro de sus propios repositorios no forjados, no dependiendo de quién sea el autor de The Commits. No incluye sus contribuciones a otros repositorios de usuarios/organizaciones. Actualmente no hay forma de obtener estos datos de la API de GitHub. Si desea que se mejore este comportamiento, puede apoyar esta solicitud de función creada por @Rickstaa dentro de la comunidad Github.
Advertencia
Actualmente, esta tarjeta muestra datos solo sobre los primeros 100 repositorios. Esto se debe a las limitaciones de la API de GitHub que causan tiempos de inactividad de instancias públicas (ver #1471). En el futuro, este comportamiento mejorará al liberar la acción de GitHub o proporcionar variables de entorno para las propias instancias del usuario.
Copie Paste este código en su ReadMe y cambie los enlaces.
Punto final: 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 )Utilizamos el siguiente algoritmo para calcular los porcentajes de idiomas en la tarjeta de idioma:
ranking_index = ( byte_count ^ size_weight ) * ( repo_count ^ count_weight ) Por defecto, solo se usa el recuento de bytes para determinar los porcentajes de idiomas que se muestran en la tarjeta del idioma (es decir, size_weight=1 y count_weight=0 ). Sin embargo, puede usar &size_weight= y &count_weight= opciones para soportar el cálculo de uso del idioma. Los valores deben ser números reales positivos. Se pueden encontrar más detalles sobre el algoritmo aquí.
&size_weight=1&count_weight=0 - (predeterminado) Pedidos por recuento de bytes.&size_weight=0.5&count_weight=0.5 - (recomendado) usa el recuento de bytes y repos&size_weight=0&count_weight=1 - órdenes por recuento de repos ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5 ) Puede usar el parámetro &exclude_repo=repo1,repo2 para excluir repositorios individuales.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&exclude_repo=github-readme-stats,anuraghazra.github.io ) Puede usar &hide=language1,language2 Parámetro para ocultar los idiomas individuales.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html ) Puede usar la opción &langs_count= para aumentar o disminuir el número de idiomas que se muestran en la tarjeta. Los valores válidos son enteros entre 1 y 20 (inclusive). Por defecto, se estableció en 5 para normal & donut y 6 para otros diseños.
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&langs_count=8 ) 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 ) Puede usar la opción &layout=donut para cambiar el diseño de la tarjeta.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut )] ( https://github.com/anuraghazra/github-readme-stats ) Puede usar la opción &layout=donut-vertical para cambiar el diseño de la tarjeta.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=donut-vertical )] ( https://github.com/anuraghazra/github-readme-stats ) Puede usar la opción &layout=pie para cambiar el diseño de la tarjeta.
[ ![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=pie )] ( https://github.com/anuraghazra/github-readme-stats ) Puede usar la opción &hide_progress=true para ocultar los porcentajes y las barras de progreso (el diseño se establecerá automáticamente en compact ).
![ Top Langs ] ( https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true )Advertencia
Tenga en cuenta que actualmente solo mostramos datos de los perfiles de Wakatime que son públicos. Por lo tanto, debe asegurarse de que tanto Display code time publicly como Display languages, editors, os, categories publicly .
Cambie el ?username= valor a su nombre de usuario wakatime.
[ ![ Harlok's WakaTime stats ] ( https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs )] ( https://github.com/anuraghazra/github-readme-stats )Elija entre cualquiera de los temas predeterminados
Por defecto, GitHub no coloca las tarjetas una al lado de la otra. Para hacer eso, puede usar este enfoque:
< a href =" https://github.com/anuraghazra/github-readme-stats " >
< img height = 200 align =" center " src =" https://github-readme-stats.vercel.app/api?username=anuraghazra " />
</ a >
< a href =" https://github.com/anuraghazra/convoychat " >
< img height = 200 align =" center " src =" https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320 " />
</ a > < 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 > Dado que la API de GitHub solo permite solicitudes de 5k por hora, mi https://github-readme-stats.vercel.app/api podría alcanzar el limitador de velocidad. Si lo aloja en su propio servidor Vercel, entonces no tiene que preocuparse por nada. ¡Haga clic en el botón Implementar para comenzar!
Nota
Desde el #58, ¿deberíamos poder manejar más de 5K solicitudes y tener menos problemas con el tiempo de inactividad?
Nota
Si está en el plan Vercel de Pro (es decir, el valor de Maxduration encontrado en Vercel.json se puede aumentar cuando su instancia de Vercel con frecuencia se desprende durante la solicitud de la tarjeta. Se le recomienda mantener este valor inferior a 30 segundos para evitar un alto uso de la memoria.
Log in .Continue with GitHub .Add New... y seleccione la opción Project .Continue with GitHub , busque el repositorio Git requerido e importe haciendo clic en el botón Import . Alternativamente, puede importar un repositorio de Git de terceros utilizando el Import Third-Party Git Repository -> enlace en la parte inferior de la página.repo y los permisos user (esto permite el acceso para ver el repositorio privado y las estadísticas de los usuarios).PAT_1 (como se muestra).Advertencia
Esta forma de usar GRS no es compatible oficialmente y se agregó para atender a algunos casos de uso particular en los que no se pudo usar VERCE (por ejemplo, #2341). El soporte para este método, por lo tanto, es limitado.
express a la sección de dependencias de package.jsongithub-readme-stats/paquete.json
Líneas 54 a 61 en BA7C2F8
npm i si es necesario (configuración inicial)node express.js para iniciar el servidor, o establezca el punto de entrada en express.js en package.json si se implementa en un servicio administradogithub-readme-stats/paquete.json
Línea 11 en BA7C2F8
Las estadísticas de lectura de GitHub contienen varias variables de entorno Vercel que se pueden usar para eliminar las protecciones del límite de velocidad:
CACHE_SECONDS : Esta variable de entorno tiene prioridad sobre nuestros valores mínimos y máximos de caché y puede eludir estos valores para instancias de Vercely autohostadas.Consulte la documentación de Vercel sobre cómo agregar estas variables de entorno a su instancia de Vercel.
Puede mantener su bifurcación y, por lo tanto, su instancia privada de Vercel actualizado con el botón Subk Sync de GitHub. También puede usar el paquete Pull creado por @Wei para automatizar este proceso.
De código abierto casi todo lo que pueda y trato de responder a todos los que necesitan ayuda para usar estos proyectos. Obviamente, esto lleva tiempo. Puede usar este servicio de forma gratuita.
Sin embargo, si está utilizando este proyecto y está contento con él o simplemente quiere alentarme a continuar creando cosas, hay algunas formas en que puede hacerlo:
¡Gracias! ❤️
¡Las contribuciones son bienvenidas! <3
Hecho con ❤️ y JavaScript.
