15 KiB
GitHub Readme Stats
Obtenez des statistiques GitHub générées dynamiquement sur vos Readme !
Voir la démo · Soumettre un bug · Demander une nouveauté
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어 . Nederlands . नेपाली
Vous aimez ce projet? Pensez à faire un don pour l'améliorer!
Features
- Carte des stats GitHub
- GitHub Extra Pins
- Carte des meilleurs langages
- Themes
- Personnalisation
- Deployer toi-même
Carte des Stats GitHub
Copiez-collez ceci dans votre Markdown, et c'est tout. C'est simple !
Remplacez la valeur ?username=
par le nom d'utilisateur de votre GitHub.
[![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
Note: Les rangs sont calculés sur la base des statistiques de l'utilisateur, voir src/calculateRank.js
Cacher les statistiques individuelles
Pour masquer des statistiques spécifiques, vous pouvez passer un paramètre de requête ?hide=
avec des valeurs séparées par des virgules.
Options:
&hide=stars,commits,prs,issues,contribs
![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
Ajouter le compte des contributions privées au compte des commits totaux
Vous pouvez ajouter le compte de toutes vos contributions privées au compte total des engagements en utilisant le paramètre de requête ?count_private=true
.
Note: Si vous déployez vous-même ce projet, les contributions privées seront comptées par défaut ; sinon, vous devez choisir de partager les comptes de vos contributions privées.
Options:
&count_private=true
![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
Afficher les icônes
Pour activer les icônes, vous pouvez passer show_icons=true
dans le paramètre de requête, comme ceci :
![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
Thèmes
Avec les thèmes intégrés, vous pouvez personnaliser l'apparence de la carte sans faire de personnalisation manuelle.
Use ?theme=THEME_NAME
parameter like so :-
![Les Stats GitHub de Anurag](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
Tous les thèmes intégrés :-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
Vous pouvez consulter un aperçu de tous les thèmes disponibles ou consulter le fichier de configuration des thèmes & vous pouvez également ajouter de nouveaux thèmes si vous le souhaitez :D
Personnalisation
Vous pouvez personnaliser l'apparence de votre Carte des stats
ou Carte de dépôt
comme vous le souhaitez avec les paramètres d'URL.
Options principales:
title_color
- Couleur du titre de la carte (hex color)text_color
- Couleur du texte (hex color)icon_color
- Couleur des icônes si disponibles (hex color)bg_color
- Couleur du fond de la carte (hex color) ou un gradiant de la forme angle,start,endhide_border
- Cache la bordure de la carte (booléen)theme
- Nom du thème, parmis tous les thèmes disponiblescache_seconds
- Paramétrer le cache manuellement (min: 1800, max: 86400)locale
- définir la langue de la carte (par exemple. cn, de, es, etc.)
Gradient in bg_color
Vous pouvez fournir plusieurs valeurs (suivie d'une virgule) dans l'option bg_color pour rendre un degradé, le format du degradé est :-
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Note relative: Les cartes dépôt ont un cache par défaut de 30 minutes (1800 secondes) si le nombre de bifurcations et d'étoiles est inférieur à 1K, alors il est de 2 heures (7200). Notez également que la mémoire cache est limitée à 30 minutes au minimum et à 24 heures au maximum.
Stats Card Exclusive Options:
hide
- Masquer les éléments spécifiés dans les statistiques (Comma seperated values)hide_title
- Masquer le titre (boolean)hide_rank
- Masquer le rang (boolean)show_icons
- Afficher les icônes (boolean)include_all_commits
- Compter le total de commits au lieu de ne compter que les commits de l'année en cours (boolean)count_private
- Compter les commits privés (boolean)line_height
- Fixer la hauteur de la ligne entre les textes (number)
Repo Card Exclusive Options:
show_owner
- Affiche le nom du propriétaire du dépôt (boolean)
Language Card Exclusive Options:
hide
- Masquer les langages spécifiés sur la carte (Comma seperated values)hide_title
- Masquer le titre (boolean)layout
- Alterner entre 2 mise en pagedefault
&compact
card_width
- Fixer la largeur de la carte manuellement (number)
⚠️ Important: Les noms des langages doivent être en format uri, comme spécifié dans Percent Encoding (c'est-à-dire que:
c++
devrait devenirc%2B%2B
,jupyter notebook
devrait devenirjupyter%20notebook
, etc.)
GitHub Extra Pins
Les épingles supplémentaires GitHub vous permettent d'épingler plus de 6 dépôts dans votre profil en utilisant un profil GitHub readme.
Et OUI ! Vous n'êtes plus limité à 6 dépôts épinglés.
Usage
Copiez-collez ce code dans votre readme et modifiez les liens.
Extrémité: api/pin?username=anuraghazra&repo=github-readme-stats
[![Carte ReadMe](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)
Démo
Utiliser la variable show_owner pour inclure le nom d'utilisateur du propriétaire du dépôt.
Carte des langages les + utilisés
La carte des langages principaux montre les langages les plus utilisés par les utilisateurs de GitHub.
NOTE: Les langages affichés n'indiquent pas mon niveau de compétence ou quelque chose comme ça, c'est une métrique GitHub de quelles langages j'ai le plus de code sur GitHub, c'est une nouvelle fonctionnalité de github-readme-stats
Usage
Copiez-collez ce code dans votre readme et modifiez les liens.
Extrémité: 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)
Cacher certaines langages
Vous pouvez utiliser le paramètre ?hide=language1,language2
pour masquer les langages individuels.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
Carte compacte des langages
Vous pouvez utiliser l'option &layout=compact
pour changer le style de la carte.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
Démo
- Carte compacte
Toutes les démos
- Défaut
- Ne pas afficher des stats spécifiques
- Afficher les icônes
- Inclure tous les commits
- Thèmes
Choisissez parmi l'un des thèmes par défaut
- Dégradé
- Personnaliser la carte des stats
- Personnaliser la carte dépôt
- Top Langages
Conseil rapide (aligner les cartes des dépôts)
En général, vous ne pourrez pas mettre les images côte à côte. Pour ce faire, vous pouvez utiliser cette approche :
<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>
Déployer sur votre propre instance Vercel
Check Out Step By Step Video Tutorial By @codeSTACKr
Comme l'API GitHub ne permet que 5k requêtes par heure, il est possible que mon https://github-readme-stats.vercel.app/api
puisse atteindre le limiteur de débit. Si vous l'hébergez sur votre propre serveur Vercel, alors vous n'avez pas à vous soucier de quoi que ce soit. Cliquez sur le bouton de déploiement pour commencer !
NOTE: Depuis #58 nous devrions être en mesure de traiter plus de 5 000 demandes et ne pas avoir de problèmes de temps d'arrêt :D
Guide pour la mise en place de Vercel 🔨
- Allez sur vercel.com
- Cliquez sur
Log in
- Connectez-vous avec GitHub en cliquant
Continue with GitHub
- Connectez-vous à GitHub et autorisez l'accès à tous les dépôts, si vous y êtes invité
- Forkez ce dépôt
- Retournez au dashboard Vercel
- Sélectionnez
Import Project
- Sélectionnez
Import Git Repository
- Choisissez root et gardez tout tel quel, ajoutez simplement votre variable d'environnement nommée PAT_1 (comme indiqué), qui contiendra un jeton d'accès personnel (PAT), que vous pouvez facilement créer ici (laissez tout tel quel, nommez le simplement quelque chose, cela peut être tout ce que vous voulez)
- Cliquez sur "Deploy" et vous êtes prêt à partir. Regardez vos domaines pour utiliser l'API !
💖 Supporter le project
Je mets open-source presque tout ce que je peux, et j'essaie de répondre à tous ceux qui ont besoin d'aide en utilisant ces projets. Évidemment, cela prend du temps. Vous pouvez utiliser ce service gratuitement.
Cependant, si vous utilisez ce projet et que vous en êtes satisfait ou si vous voulez simplement m'encourager à continuer à créer, il y a quelques façons de le faire :-
- Donner un crédit approprié lorsque vous utilisez github-readme-stats sur votre readme, avec un lien vers celui-ci :D
- Mettre une étoile et partager le projet 🚀
- - Vous pouvez faire des dons uniques via PayPal. Je vais probablement acheter un
caféthé. 🍵
Merci ! ❤️
Les contributions sont les bienvenues ! <3
Fait avec ❤️ et JavaScript.