Git2Web

Git2Web est une librairie Node.js permettant de générer automatiquement une page web dynamique à partir des informations d'un dépôt GitHub. Cette page inclut des statistiques, des topics, et un affichage stylisé du contenu du README.md.

✨ Fonctionnalités

• 🚀 Génération automatique d'une page HTML complète et stylisée.
• 📊 Affichage des statistiques clés : étoiles, forks, problèmes ouverts, etc.
• 📝 Récupération et rendu du contenu du fichier README.md avec coloration syntaxique.
• 🎨 Design moderne basé sur TailwindCSS et Prism.js.
• 🌍 Fonctionne avec tous les dépôts publics GitHub.
• 🔐 Prise en charge des dépôts privés via un token GitHub.

📦 Installation

Installation Globale

Pour utiliser Git2Web comme commande CLI, installez-le globalement :

  npm install -g Git2Web

Installation dans un projet node

Pour utiliser Git2Web dans un projet Node.js, installez-le en tant que dépendance :

npm install Git2Web

🚀 Utilisation

Utilisation en tant que commande CLI

1. Génération de Page HTML : Exécutez la commande suivante avec l'URL d'un dépôt GitHub :

     Git2Web https://github.com/<username>/<repository>

   • Le fichier HTML sera généré dans le dossier output par défaut.
   • Pour spécifier un autre dossier de sortie, ajoutez un deuxième argument :

     Git2Web https://github.com/<username>/<repository> <output-folder>

2. Configuration du Token GitHub :

   • Si vous atteignez les limites de l'API GitHub, configurez un token (voir section Configuration du Token GitHub).

Utilisation dans un projet Node.js

1. Importez la librairie dans votre projet :

     const {generatePage} = require('Git2Web');

2. Appelez la fonction generatePage avec l'URL du dépôt et le chemin de sortie :

     const repoUrl = 'https://github.com/Seishiiin/personal-dashboard';
   
     generatePage(repoUrl, './output')
       .then(() => console.log('Page générée avec succès !'))
       .catch((error) => console.error('Erreur :', error.message));

3. Options :

   • Le premier argument de generatePage est l'URL du dépôt GitHub.
   • Le deuxième argument est le chemin de sortie du fichier HTML (par défaut : output et optionnel).

🔐 Configuration du Token GitHub

Pour accéder aux dépôts privés ou augmenter les limites de l'API GitHub, vous pouvez configurer un token d'accès personnel.

1. Générez un nouveau token d'accès personnel sur GitHub :

   • Allez sur GitHub > Settings > Developer settings > Personal access tokens.
   • Cliquez sur "Generate new token" et sélectionnez les permissions nécessaires :
     • repo : pour accéder aux dépôts privés.
     • read:user : pour accéder aux informations de l'utilisateur.
   • Copiez le token généré.

2. Créez un fichier .env à la racine de votre projet avec la clé GITHUB_TOKEN :

     GITHUB_TOKEN=your_access_token

3. Ajoutez .env à votre fichier .gitignore pour ne pas le pousser sur GitHub :

     .env

🎨 Personnalisation

Vous pouvez personnaliser le rendu HTML en modifiant les fichiers suivants :

• src/templates/template.html :
  • Ce fichier contient le modèle HTML de la page générée.
  • Modifiez les balises ou ajoutez vos propres classes CSS pour changer le design.
• Classes CSS :
  • Les classes CSS utilisées sont basées sur TailwindCSS.
  • Ajoutez ou modifiez les classes directement dans le fichier template.html.

💡 Notes techniques

• La librairie utilise dotenv pour charger les variables d'environnement (comme le token GitHub).
• Les blocs de code dans le contenu Markdown sont stylisés avec Prism.js.
• Tous les fichiers générés sont placés dans le dossier output par défaut, sauf indication contraire.

📥 Contribuer

Les contributions sont les bienvenues ! Voici comment vous pouvez participer :

1. Signaler un bug : ouvrir une issue.
2. Proposer une amélioration : ouvrir une pull request.
3. Améliorer la documentation : les améliorations de la documentation sont toujours appréciées.

📄 Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus d'informations.

Créé avec ❤️ par Seishin.