|
| 1 | +# Documentation Site / GitHub Pages |
| 2 | + |
| 3 | +Ce dossier contient la documentation et le site web statique pour py-stats-toolkit, hébergé gratuitement sur GitHub Pages. |
| 4 | + |
| 5 | +## 🌐 Accès au site |
| 6 | + |
| 7 | +Le site est accessible à l'adresse : **https://phoenixguardiantools.github.io/py-stats-toolkit/** |
| 8 | + |
| 9 | +## 🎯 Objectif |
| 10 | + |
| 11 | +Ce site répond à la question : "Comment avoir un nom de domaine gratuit comme github.io?" |
| 12 | + |
| 13 | +GitHub Pages offre un hébergement gratuit avec un domaine automatique au format : |
| 14 | +- `username.github.io` pour les sites utilisateur/organisation |
| 15 | +- `username.github.io/repository-name` pour les sites de projet |
| 16 | + |
| 17 | +## 📁 Structure |
| 18 | + |
| 19 | +``` |
| 20 | +docs/ |
| 21 | +├── index.html # Page d'accueil principale |
| 22 | +├── 404.html # Page d'erreur personnalisée |
| 23 | +├── robots.txt # Configuration pour les moteurs de recherche |
| 24 | +├── sitemap.xml # Plan du site pour SEO |
| 25 | +├── _config.yml # Configuration Jekyll |
| 26 | +├── CNAME.example # Exemple pour domaine personnalisé |
| 27 | +└── README.md # Cette documentation |
| 28 | +``` |
| 29 | + |
| 30 | +## 🚀 Déploiement automatique |
| 31 | + |
| 32 | +Le site est déployé automatiquement via GitHub Actions (`.github/workflows/deploy-pages.yml`) à chaque push sur la branche principale. |
| 33 | + |
| 34 | +## 🎨 Fonctionnalités du site |
| 35 | + |
| 36 | +- ✅ Design responsive et moderne |
| 37 | +- ✅ Installation et exemples d'utilisation |
| 38 | +- ✅ Liens vers PyPI et GitHub |
| 39 | +- ✅ SEO optimisé |
| 40 | +- ✅ Meta tags Open Graph et Twitter Card |
| 41 | +- ✅ Favicon personnalisé |
| 42 | +- ✅ Page 404 personnalisée |
| 43 | + |
| 44 | +## 📈 SEO et référencement |
| 45 | + |
| 46 | +- Sitemap XML pour l'indexation |
| 47 | +- Robots.txt configuré |
| 48 | +- Meta descriptions optimisées |
| 49 | +- Structure HTML sémantique |
| 50 | +- Schema.org markup |
| 51 | + |
| 52 | +## 💡 Domaine personnalisé (optionnel) |
| 53 | + |
| 54 | +Pour utiliser un domaine personnalisé : |
| 55 | +1. Ajouter un fichier `CNAME` avec votre domaine |
| 56 | +2. Configurer les DNS chez votre registrar |
| 57 | +3. Activer HTTPS dans les paramètres GitHub Pages |
| 58 | + |
| 59 | +## 🔧 Modifications |
| 60 | + |
| 61 | +Pour modifier le site : |
| 62 | +1. Éditez les fichiers dans le dossier `docs/` |
| 63 | +2. Committez et pushez les changements |
| 64 | +3. Le site se met à jour automatiquement |
0 commit comments