@@ -6,12 +6,9 @@ Générateur automatique de statistiques GitHub avec plusieurs variantes.
66
77Ce projet génère automatiquement des images SVG affichant vos langages les plus utilisés :
88
9+ - ` stats-top2.svg ` - Top 2 langages
910- ` stats-top4.svg ` - Top 4 langages
10- - ` stats-top5.svg ` - Top 5 langages
1111- ` stats-top6.svg ` - Top 6 langages
12- - ` stats-top7.svg ` - Top 7 langages
13- - ` stats-top8.svg ` - Top 8 langages
14- - ` stats.svg ` - Version par défaut (top 5)
1512
1613## 🚀 Installation
1714
@@ -35,15 +32,23 @@ github-stats/
3532├── .github/
3633│ └── workflows/
3734│ └── update-stats.yml
35+ ├── config.json
3836├── generate-stats.js
37+ ├── github_colors.json
3938└── README.md
4039```
4140
42- ### 3. Modifier le username
41+ ### 3. Modifier la configuration
4342
44- Dans ` generate-stats.js ` , ligne 4, remplacez :
45- ``` javascript
46- const USERNAME = ' votre-username' ; // Mettez votre username GitHub
43+ Dans ` config.json ` , modifiez les valeurs selon vos besoins :
44+
45+ ``` json
46+ {
47+ "USERNAME" : " votre-username" ,
48+ "TITLE" : " Langages Utilisés" ,
49+ "VARIANTS" : [2 , 4 , 6 ],
50+ "IGNORE_LANGUAGES" : [" HTML" , " CSS" , " Handlebars" , " SCSS" ]
51+ }
4752```
4853
4954### 4. Créer un token GitHub
@@ -76,13 +81,15 @@ const USERNAME = 'votre-username'; // Mettez votre username GitHub
7681Deux options :
7782
7883** Option A - Automatique :**
84+
7985``` bash
8086git add .
8187git commit -m " Initial setup"
8288git push
8389```
8490
8591** Option B - Manuel :**
92+
86931 . Allez dans l'onglet "Actions" de votre repo
87942 . Cliquez sur le workflow "Update GitHub Stats"
88953 . Cliquez sur "Run workflow"
@@ -92,67 +99,85 @@ git push
9299Une fois déployé, vos images seront disponibles aux URLs :
93100
94101```
102+ https://votre-username.github.io/github-stats/stats-top2.svg
95103https://votre-username.github.io/github-stats/stats-top4.svg
96- https://votre-username.github.io/github-stats/stats-top5.svg
97104https://votre-username.github.io/github-stats/stats-top6.svg
98- https://votre-username.github.io/github-stats/stats-top7.svg
99- https://votre-username.github.io/github-stats/stats-top8.svg
100- https://votre-username.github.io/github-stats/stats.svg
101105```
102106
107+ > ** Note :** Les fichiers générés dépendent de la configuration ` VARIANTS ` dans ` config.json ` .
108+
103109### Dans un README :
104110
105111``` markdown
106- ![ Top 5 Languages] ( https://votre-username.github.io/github-stats/stats-top5 .svg )
112+ ![ Top 5 Languages] ( https://votre-username.github.io/github-stats/stats-top4 .svg )
107113```
108114
109115### En HTML :
110116
111117``` html
112- <img src =" https://votre-username.github.io/github-stats/stats-top5.svg" alt =" Top Languages" >
118+ <img
119+ src =" https://votre-username.github.io/github-stats/stats-top4.svg"
120+ alt =" Top Languages"
121+ />
113122```
114123
124+ ### Exemple :
125+
126+ <img src =" https://fabiodevcode.github.io/github-stats/stats-top4.svg " alt =" top 4 languages " >
127+
115128## ⚙️ Configuration
116129
130+ Toute la configuration se fait dans le fichier ` config.json ` :
131+
132+ ``` json
133+ {
134+ "USERNAME" : " votre-username" ,
135+ "TITLE" : " Langages Utilisés" ,
136+ "BG_COLOR" : " #202830" ,
137+ "BORDER_COLOR" : " #202830" ,
138+ "TITLE_COLOR" : " #D1D7E0" ,
139+ "TEXT_COLOR" : " #D1D7E0" ,
140+ "PERCENT_COLOR" : " #9298A1" ,
141+ "VARIANTS" : [2 , 4 , 6 ],
142+ "IGNORE_LANGUAGES" : [" HTML" , " CSS" , " Handlebars" , " SCSS" ]
143+ }
144+ ```
145+
146+ ### Options disponibles
147+
148+ | Option | Description | Exemple |
149+ | ------------------ | ------------------------------------ | --------------------- |
150+ | ` USERNAME ` | Votre nom d'utilisateur GitHub | ` "FabioDevCode" ` |
151+ | ` TITLE ` | Titre affiché sur l'image | ` "Langages Utilisés" ` |
152+ | ` BG_COLOR ` | Couleur de fond | ` "#202830" ` |
153+ | ` BORDER_COLOR ` | Couleur de la bordure | ` "#202830" ` |
154+ | ` TITLE_COLOR ` | Couleur du titre | ` "#D1D7E0" ` |
155+ | ` TEXT_COLOR ` | Couleur du texte | ` "#D1D7E0" ` |
156+ | ` PERCENT_COLOR ` | Couleur des pourcentages | ` "#9298A1" ` |
157+ | ` VARIANTS ` | Variantes à générer (top N langages) | ` [2, 4, 6, 8] ` |
158+ | ` IGNORE_LANGUAGES ` | Langages à exclure des stats | ` ["HTML", "CSS"] ` |
159+
117160### Changer la fréquence de mise à jour
118161
119162Dans ` .github/workflows/update-stats.yml ` , modifiez la ligne cron :
120163
121164``` yaml
122165schedule :
123- - cron : ' 0 0 * * *' # Tous les jours à minuit
124- - cron : ' 0 */6 * * *' # Toutes les 6 heures
125- - cron : ' 0 0 * * 1' # Tous les lundis
126- ` ` `
127-
128- ### Personnaliser les couleurs
129-
130- Dans ` generate-stats.js`, modifiez l'objet `COLORS` :
131-
132- ` ` ` javascript
133- const COLORS = {
134- background: '#0d1117',
135- title: '#58a6ff',
136- text: '#c9d1d9',
137- subtext: '#8b949e',
138- bar: '#0366d6'
139- };
166+ - cron : " 0 0 * * *" # Tous les jours à minuit
167+ - cron : " 0 */6 * * *" # Toutes les 6 heures
168+ - cron : " 0 0 * * 1" # Tous les lundis
140169` ` `
141170
142- # ## Ajouter d'autres variantes
171+ ### Couleurs des langages
143172
144- Dans `generate-stats.js`, modifiez le tableau `variants` :
145-
146- ` ` ` javascript
147- const variants = [3, 4, 5, 10]; // Génèrera top3, top4, top5, top10
148- ` ` `
173+ Les couleurs des langages sont définies dans ` github_colors.json`. Ce fichier contient les couleurs officielles GitHub pour chaque langage. Vous pouvez le modifier si nécessaire.
149174
150175# # 🐛 Dépannage
151176
152177# ## L'action échoue
153178
1541791. Vérifiez que le token `GH_TOKEN` est bien configuré
155- 2. Vérifiez que le username dans `generate-stats.js ` est correct
180+ 2. Vérifiez que le `USERNAME` dans `config.json ` est correct
1561813. Consultez les logs dans l'onglet "Actions"
157182
158183# ## Les images ne s'affichent pas
@@ -173,4 +198,4 @@ Ce projet est libre d'utilisation pour votre usage personnel.
173198
174199---
175200
176- **Note :** Les statistiques sont mises à jour automatiquement chaque jour. Les repositories forkés sont exclus du calcul.
201+ **Note :** Les statistiques sont mises à jour automatiquement chaque jour. Les repositories forkés sont exclus du calcul.
0 commit comments