Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Deploy GitHub Pages

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload docs directory
path: './docs'

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,11 @@ Le projet utilise GitHub Actions pour l'automatisation :

## 📚 Documentation

- **🌐 [Site officiel](https://phoenixguardiantools.github.io/py-stats-toolkit/)** - Hébergé gratuitement sur GitHub Pages
- [Documentation complète](https://py-stats-toolkit.readthedocs.io/)
- [Exemples d'utilisation](https://github.com/PhoenixGuardianTools/py-stats-toolkit/tree/main/examples)
- [Guide de contribution](CONTRIBUTING.md)
- [Guide GitHub Pages](GITHUB_PAGES_GUIDE.md) - Comment avoir un domaine gratuit comme github.io

## 🧪 Tests et Qualité du Code

Expand Down
70 changes: 70 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<!DOCTYPE html>
<html lang="fr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Page non trouvée - Py-Stats-Toolkit</title>
<style>
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', sans-serif;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
color: white;
margin: 0;
padding: 0;
height: 100vh;
display: flex;
align-items: center;
justify-content: center;
text-align: center;
}

.container {
max-width: 600px;
padding: 2rem;
}

.error-code {
font-size: 8rem;
font-weight: bold;
margin-bottom: 1rem;
opacity: 0.8;
}

h1 {
font-size: 2rem;
margin-bottom: 1rem;
}

p {
font-size: 1.2rem;
margin-bottom: 2rem;
opacity: 0.9;
}

.btn {
display: inline-block;
padding: 12px 24px;
background: rgba(255, 255, 255, 0.2);
color: white;
text-decoration: none;
border-radius: 6px;
border: 2px solid rgba(255, 255, 255, 0.3);
font-weight: 600;
transition: all 0.3s ease;
}

.btn:hover {
background: white;
color: #667eea;
}
</style>
</head>
<body>
<div class="container">
<div class="error-code">404</div>
<h1>Page non trouvée</h1>
<p>Désolé, la page que vous recherchez n'existe pas.</p>
<a href="/py-stats-toolkit/" class="btn">← Retour à l'accueil</a>
</div>
</body>
</html>
3 changes: 3 additions & 0 deletions docs/CNAME.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# This file is not currently used but can be configured later
# for custom domain setup. For now, the site is available at:
# https://phoenixguardiantools.github.io/py-stats-toolkit/
64 changes: 64 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Documentation Site / GitHub Pages

Ce dossier contient la documentation et le site web statique pour py-stats-toolkit, hébergé gratuitement sur GitHub Pages.

## 🌐 Accès au site

Le site est accessible à l'adresse : **https://phoenixguardiantools.github.io/py-stats-toolkit/**

## 🎯 Objectif

Ce site répond à la question : "Comment avoir un nom de domaine gratuit comme github.io?"

GitHub Pages offre un hébergement gratuit avec un domaine automatique au format :
- `username.github.io` pour les sites utilisateur/organisation
- `username.github.io/repository-name` pour les sites de projet

## 📁 Structure

```
docs/
├── index.html # Page d'accueil principale
├── 404.html # Page d'erreur personnalisée
├── robots.txt # Configuration pour les moteurs de recherche
├── sitemap.xml # Plan du site pour SEO
├── _config.yml # Configuration Jekyll
├── CNAME.example # Exemple pour domaine personnalisé
└── README.md # Cette documentation
```

## 🚀 Déploiement automatique

Le site est déployé automatiquement via GitHub Actions (`.github/workflows/deploy-pages.yml`) à chaque push sur la branche principale.

## 🎨 Fonctionnalités du site

- ✅ Design responsive et moderne
- ✅ Installation et exemples d'utilisation
- ✅ Liens vers PyPI et GitHub
- ✅ SEO optimisé
- ✅ Meta tags Open Graph et Twitter Card
- ✅ Favicon personnalisé
- ✅ Page 404 personnalisée

## 📈 SEO et référencement

- Sitemap XML pour l'indexation
- Robots.txt configuré
- Meta descriptions optimisées
- Structure HTML sémantique
- Schema.org markup

## 💡 Domaine personnalisé (optionnel)

Pour utiliser un domaine personnalisé :
1. Ajouter un fichier `CNAME` avec votre domaine
2. Configurer les DNS chez votre registrar
3. Activer HTTPS dans les paramètres GitHub Pages

## 🔧 Modifications

Pour modifier le site :
1. Éditez les fichiers dans le dossier `docs/`
2. Committez et pushez les changements
3. Le site se met à jour automatiquement
Loading
Loading