Hugo est un générateur de sites statiques. Bien que la plupart des thèmes soient adaptés au format «blog», l’outil est très flexible et on peut l’adapter à d’autres besoins.

Vous n’avez pas besoin d’installer Hugo pour l’utiliser sur mplx : il est déjà installé sur le serveur.

Vous aurez en revanche besoin d’un accès Git à un dépot hébergé sur mplssg. Vous conserverez une copie de ce dépot sur votre ordinateur.

La génération du site se fait via un hook git, activé lorsque vous synchronisez votre dépot local vers le dépot de mplssg.

Git n’est pas adapté à la gestion de fichiers volumineux car tout fichier est conservé dans son historique et occupe de l’espace disque même si vous le supprimez par un commit. Evitez de mettre des gros fichiers dans vos dépots git !

Demander un site Hugo

Si vous avez un nom de domaine

Indiquez-le quand vous faites votre demande.

Votre zone DNS devra contenir un champ A avec l’adresse IP du serveur mplx, ou bien un champ CNAME ayant pour valeur sites.mplx.ml.

Si vous ne possédez pas de nom de domaine

(pas encore prêt !)

Dans ce cas, choisissez le nom du site. Celui-ci sera accessible via : https://sites.mplx.ml/<nomdusite>.

Accès au dépot Git de votre site Hugo

Le dépot Git est situé sur mplssg, dans un sous-répertoire nommé hugo.

git clone mplssg:hugo/<nomdusite>.git

Il est préconfiguré et contient déjà quelques fichiers pour faciliter la mise en marche du site.

Configurer

Thèmes

Le thème conditionne en partie les règles à suivre pour créer du contenu, et le type d’usage (blog, documentation technique…).

Hugo étant flexible, vous pouvez aussi créer votre propre thème, layouts… dans votre dépot Hugo, si vous savez comment faire.

Thèmes déjà installés sur le serveur :

Créer du contenu

Rédigez vos articles au format markdown (fichiers .md).

En très bref :

Exemple, un fichier <répertoire du dépot git>/content/musique/super_album.md :

---
title: Mon super album
---

Que vous pouvez [télécharger ici](/albums/super_album.zip).

super_album.zip sera stocké dans <répertoire du dépot git>/static/albums/super_album.zip.

Publier le site avec git

Vous rédigez d’abord vos articles dans le dépot git que vous avez cloné sur votre ordinateur.

Quand vous avez terminé la redaction, c’est là qu’intervient git. C’est un outil qui s’apprivoise, voyons son usage le plus simple.

Demandez à git de prendre en compte tous les fichiers et toutes les modifications effectuées dans le dépot :

git add -A

Donnez une description de la nature de votre travail.

git commit -m "Ajout d'une section instruments + correction date de sortie d'alboum"

Enfin, envoyez la sauce : synchronisez le dépot git, ce qui provoquera la génération du site.

git push

D’autres commandes utiles : git status, git add ., git log, git diff --cached

Faire des essais localement

Pour cela, installez Hugo sur votre ordi, allez dans le répertoire de votre dépot git, puis lancez :

hugo server -D

Rendez vous ensuite sur http://127.0.0.1:1313/ avec votre navigateur web : les modifications que vous effectuez y seront visibles.

Documentation complémentaire