Hugo

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 utiliser ce service : il est déjà installé sur le serveur.

Vous avez besoin d’un accès Git à un dépot hébergé sur mplssg, dont vous conserverez une copie 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 donc de l’espace disque même si vous le supprimez par un commit. Essayez de prendre cela en considération !

Demander un site Hugo

Si vous avez un nom de domaine

Si vous possédez un nom de domaine, vous pouvez le communiquer.

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

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 mplssh:hugo/<nomdusite>.git

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

Configurer

Thèmes

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

  • Learn (utilisé par défaut)

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.

Créer du contenu

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

En très bref :

  • Rendez-vous dans content, et placez-y un fichier _index.md. Ce fichier sera la page d’accueil du site.
  • Créez un dossier dans content, par exemple, recettes, et placez-y les fichiers de vos articles. Par exemple, gaufre.md. Le chemin complet sera <répertoire du dépot git>/content/recettes/gaufre.md
  • Copiez vos fichiers d’images, sons, de préférence dans un sous-dossier de static.
  • Faites précéder vos articles par une entête (Front Matter) indiquant a minima le titre de l’article.

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.

Documentation supplémentaire