Skip to content
Snippets Groups Projects
README.md 2.27 KiB
Newer Older
# Pour créer un site web et ressources d'une UE avec Hugo
Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed
[La page de l'UE est ici](http://alexandre.meyer.pages.univ-lyon1.fr/lifapcd/)
Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed
## Explication de la génération
Alexandre MEYER's avatar
Alexandre MEYER committed

Le site web est désormais fabriqué par ```Hugo``` (thème [congo](https://jpanther.github.io/congo/)). les sources se trouvent dans le répertoire ```web```. Le site web est mis à jour par intégration continue (CI/CD) à chaque fois que vous faites un push (rien besoin d'autre, à part attendre quelques secondes). Le script d'intégration continue est ```.gitlab-ci.yml```.  Pour voir le résultat du script de génération, depuis l'interface allez dans Buil/CI/Jobs.
Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed
Le fichier ```site/config.toml``` permet de configurer la génération du site. Mais normalement il n'y a pas besoin d'y toucher.
Alexandre MEYER's avatar
Alexandre MEYER committed
   * Les pages web sont générées à partir du répertoire ```web/content```. 
Alexandre MEYER's avatar
Alexandre MEYER committed
         * Par exemple ```web/content/doc``` peut contenir les documents généraux de l'UE (pdf);
Alexandre MEYER's avatar
Alexandre MEYER committed
   * La page principale du site est ```web/content/_index.html```. Il faut bien laissé le ```_```, il indique qu'il y a des sous-répertoires 
Alexandre MEYER's avatar
Alexandre MEYER committed
   * ```web/static``` : les fichiers générales (images, icones, etc.) sont à ranger dedans. Par exemple, il y a 
Alexandre MEYER's avatar
Alexandre MEYER committed
      * ```web/static/images``` pour les images du site;
   * Pour changer l'icone de la page web, il faut générer des icones avec un [flavicon générator](https://favicon.io/favicon-generator/), copier toutes les images dans le repertoire `static` et ajouter dans `config.toml` une ligne dans `param` avec   `favicon = "favicon.ico"`.
Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed
## Si Fork
Par défaut, gitlab ajoute des '-' un peu partout, vous pouvez changer l'adresse web dans Settings/General/Advanced/Change path.
Alexandre MEYER's avatar
Alexandre MEYER committed
# Si problème de thème non utilisé
Dans deploy/page il ne faut pas cocher  "Use unique domain"
Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed
## Tester le site en local
Pour tester vos mises à jour en local :
   * installer hugo : ```sudo apt install hugo```
   * dans le répertoire web, faire ```hugo serve```
   * dans votre navigateur, entrez l'url ```localhost:8000```
Alexandre MEYER's avatar
Alexandre MEYER committed

Alexandre MEYER's avatar
Alexandre MEYER committed
Vous pouvez aussi essayer de contruire le site en static en faisant juste ```hugo``` : le site sera constuit dans le répertoire public.
Alexandre MEYER's avatar
Alexandre MEYER committed
Toutes les infos sont détaillées ici !
Alexandre MEYER's avatar
Alexandre MEYER committed
Pour convertir du DOKUWIKI en Markdown, on peut utiliser pandoc??? (todo) ou certains web en ligne.