Parfait 🚀 ! Voici les deux documents prêts à copier-coller :
# 📘 Documentation Template (Hugo + Hextra)
[](https://github.com/wilonweb/Documentation-Template/actions/workflows/deploy.yml)
Template de documentation moderne basé sur **[Hugo](https://gohugo.io/)** et le thème **[Hextra](https://imfing.github.io/hextra/)**.
Déployé automatiquement sur **GitHub Pages** via GitHub Actions.
🌐 **Documentation en ligne** :
👉 [https://wilonweb.github.io/Documentation-Template/](https://wilonweb.github.io/Documentation-Template/)
---
## 🚀 Utilisation
### En local
```bash
# Cloner le template
git clone https://github.com/wilonweb/Documentation-Template.git
cd Documentation-Template
# Lancer en local
hugo server -D
➡️ Ouvrir http://localhost:1313/docs/
Un push sur main
déclenche automatiquement le workflow GitHub Actions → build & déploiement sur GitHub Pages.
- ⚡️ Hugo Extended + Hextra (sidebar, recherche, dark mode, Mermaid, etc.)
- 🔄 Déploiement automatique via GitHub Actions
- 📝 Exemple de documentation dans
content/docs/
- 🎨 Scripts batch/sh pour automatiser la configuration
Libre d’utilisation comme template.
---
## 📄 `DOCS-SETUP.md`
```markdown
# 🛠 Journal de mise en place – Hugo + Hextra + GitHub Pages
## 1. Création du repo
- Repo GitHub : **Documentation-Template**
- Clone local → dossier `9-Hugo-Hextra/`
## 2. Installation des outils
- **Hugo Extended** (v0.147.1)
- **Go** (v1.25.0) pour Hugo Modules
## 3. Initialisation du site Hugo
```bash
hugo new site . --force
hugo mod init github.com/wilonweb/Documentation-Template
hugo.toml
minimal :
baseURL = "/"
languageCode = "fr"
title = "Ma Doc"
enableRobotsTXT = true
enableGitInfo = true
[module]
[[module.imports]]
path = "github.com/imfing/hextra"
[markup]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
style = "github"
Récupération du thème :
hugo mod get github.com/imfing/hextra@latest
hugo mod tidy
hugo mod vendor
content/docs/_index.md
→ Documentationcontent/docs/intro.md
→ Introduction (avec Mermaid)- Sidebar d’Hextra affichée avec succès
- Cause :
menus.toml
généré avec des entrées[[sidebar]]
en plus decontent/docs
- Fix : supprimer
config/_default/menus.toml
- Garder la génération automatique de la sidebar depuis
content/docs
01-init-site.sh
→ init Hugo + Hextra02-add-docs-sample.sh
→ pages de test03-add-actions-pages.sh
→ workflow Pages06-tune-site.sh
→ tuning interactif (apparence, recherche, repoURL, baseURL, etc.)
Workflow .github/workflows/deploy.yml
:
-
Build avec Hugo Extended
-
BaseURL injecté automatiquement :
https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/
-
Déploiement via
actions/deploy-pages@v4
-
Pages activées dans Settings → Pages → GitHub Actions
👉 Résultat attendu : https://wilonweb.github.io/Documentation-Template/
- Structurer
content/docs/
avec plusieurs pages (install.md
,usage.md
,faq.md
) - Ajouter un badge Pages dans README (déjà fait ✅)
- Garder ce fichier comme journal technique (DOCS-SETUP.md)
---
👉 Mets `README.md` en racine pour présenter le projet aux visiteurs, et `DOCS-SETUP.md` pour toi (historique + guide technique).
Veux-tu que je t’ajoute aussi une **arbo de base `docs/`** (intro, install, usage, faq) prête pour ton template ?