Skip to content

wilonweb/Documentation-Template

Repository files navigation

Parfait 🚀 ! Voici les deux documents prêts à copier-coller :


📄 README.md

# 📘 Documentation Template (Hugo + Hextra)

[![Deploy Hugo to Pages](https://github.com/wilonweb/Documentation-Template/actions/workflows/deploy.yml/badge.svg)](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/

Déploiement

Un push sur main déclenche automatiquement le workflow GitHub Actions → build & déploiement sur GitHub Pages.


📦 Fonctionnalités

  • ⚡️ 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

📜 Licence

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

4. Ajout du thème Hextra (via Modules)

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

5. Création de contenu de test

  • content/docs/_index.md → Documentation
  • content/docs/intro.md → Introduction (avec Mermaid)
  • Sidebar d’Hextra affichée avec succès

6. Problème de doublon "Introduction"

  • Cause : menus.toml généré avec des entrées [[sidebar]] en plus de content/docs
  • Fix : supprimer config/_default/menus.toml
  • Garder la génération automatique de la sidebar depuis content/docs

7. Automatisations (scripts batch/)

  • 01-init-site.sh → init Hugo + Hextra
  • 02-add-docs-sample.sh → pages de test
  • 03-add-actions-pages.sh → workflow Pages
  • 06-tune-site.sh → tuning interactif (apparence, recherche, repoURL, baseURL, etc.)

8. Déploiement GitHub Pages

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/


🔮 Prochaines étapes

  • 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 ?

About

Créer une documentation avec HUGO HEXTRA

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages