Clonnage de votre dépot

git clone https://gitlab.bordeaux-inp.fr/cours/courses/<votre_cours>.git
cd <votre_cours>
Note

Remplacez <votre_cours> par le nom de votre dépot

Initialisation de la template

Depuis le racine de votre dépot (<votre_cours>):

git remote add template https://gitlab.bordeaux-inp.fr/cours/templates/modele-page-de-cours.git
git fetch template
git checkout -b main
git checkout template/main -- .
git remote remove template

Modification du nom du module

Dans différents emplacement de la template, ${course_name} est utilisé, mais doit être remplacé par le nom de votre dépot Gitlab.
Pour cela, vous pouvez utiliser le script tools/set_name.py fourni dans la template, qui effectue tous les remplacements nécessaires :

python3 tools/set_name.py

Installation des dépendances

hugo mod graph
hugo mod get -u
hugo mod tidy
hugo mod npm pack
npm install

Test local

Il est possible de tester localement votre page de cours avant de la publier. Pour cela, utilisez la commande suivante à la racine de votre dépot :

hugo server
Note

Si vous voyez un message du type :

Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) 
Press Ctrl+C to stop>

alors tout est bien configuré et installé ! Vous pouvez ouvrir votre navigateur à l’adresse http://localhost:1313/ (ou celle indiquée dans le message) pour voir votre page de cours en local.

Info

Toute modification des fichiers source devrait se refléter automatiquement dans le navigateur après sauvegarde.

Ctrl + C dans le terminal permet d’arrêter le serveur local.

Modification du contenu

Bravo !

Vous pouvez désormais éditer les fichiers de votre dépot pour personnaliser votre page de cours.

Conseil

N’hésitez pas à consulter le tutoriel ci-dessous sur l’ajout de contenu !