Last modified by Gregory CAUCHIE on 2026/04/14 10:22

From version 3.2
edited by Jean-Clément AUDUSSEAU
on 2025/05/09 09:53
Change comment: There is no comment for this version
To version 2.4
edited by Jean-Clément AUDUSSEAU
on 2025/03/31 14:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -14,10 +14,10 @@
14 14  
15 15  - À définir dans le front-matter du fichier .md (texte indépendant qui n’est pas un extrait du début de l’article)
16 16  
17 -~#~# `<title>`
17 +~#~# <title>
18 18  
19 -- `~{~{ site.Title }}` fait référence au titre dans le fichier de configuration hugo.toml (e.g. title = 'Koevoo'). Est utilisé dans le `<head>` de home.html pour définir le titre du site.
20 -- `~{~{ page.Title}}` fait référence au titre des différentes pages et articles pour adapter la balise `<title>`. Est utilisé dans le `<head>` de head-blog.html
19 +- ~{~{ site.Title }} fait référence au titre dans le fichier de configuration hugo.toml (e.g. title = 'Koevoo'). Est utilisé dans le <head> de home.html pour définir le titre du site.
20 +- ~{~{ page.Title}} fait référence au titre des différentes pages et articles pour adapter la balise <title>. Est utilisé dans le <head> de head-blog.html
21 21  - Utilisé en complément de `pluralizeListTitles = false ; titleCaseStyle = 'firstupper'` définie dans hugo.toml (cf ci-dessous)
22 22  
23 23  ~#~# shortcode et CSS en markdown
... ... @@ -28,7 +28,7 @@
28 28  
29 29  ~#~# backtick
30 30  
31 -- le backtick pour insérer du code en markdown est transformé en balise `<code>` dans le html par HUGO. Une classe CSS est configuré pour un surlignage dans le fichier markdown.css
31 +- le backtick ` pour insérer du code en markdown est transformé en balise <code> dans le html par HUGO. Une classe CSS est configuré pour un surlignage dans le fichier markdown.css
32 32  
33 33  ~#~# Liste à puces
34 34  
... ... @@ -94,81 +94,64 @@
94 94  
95 95  ~#~# hugo.toml
96 96  
97 -```
98 -pluralizeListTitles = false
97 + pluralizeListTitles = false
99 99   titleCaseStyle = 'firstupper'
100 -```
99 +
101 101  Permet respectivement d’enlever une fonction pas défaut de HUGO qui ajoute un pluriel au titre. Et de n’ajouter une majuscule qu’au 1er mot d’un titre (et non à tous les mots d’un titre par défaut)
102 102  
103 -```
104 -[markup.goldmark.renderer]
105 - unsafe= true
106 -```
102 + [markup.goldmark.renderer]
103 + unsafe= true
104 +
107 107  est utile pour permettre le rendu markdown dans les shortcodes (en utilisant %).
108 108  
109 -```
110 -[markup.goldmark.parser.attribute]
111 - block = true
112 - title = true
113 -```
107 + [markup.goldmark.parser.attribute]
108 + block = true
109 + title = true
110 +
114 114  Pour débloquer la fonction {.class} pour utiliser du css dans le markdown via HUGO.
115 115  
116 -```
117 -baseURL = 'https:~/~/preprod.koevoo.fr'
118 -[params]
119 - links_url = "https:~/~/preprod.koevoo.fr"
120 -```
113 + baseURL = 'https:~/~/preprod.koevoo.fr'
114 + [params]
115 + links_url = "https:~/~/preprod.koevoo.fr"
116 +
121 121  À modifier lors d’un changement d’URL. Le paramètre `links_url` a été créé pour configurer l’adresse correcte d’un article pour partager vers d’autres sites (single.html -> global-share-icons).\
122 122  Ex : `href="~{~{ .Site.Params.links_url | safeURL }}~{~{ .RelPermalink | safeURL }}"`\
123 123  Le paramètre baseURL ne fonctionne pas et renvoie `localhost` (lié à l’utilisation du serveur d’HUGO qui ne prend pas en compte `baseURL` ?).
124 124  Est également utile pour générer les liens dans le template sitemap.xml (/layouts/sitemap.xml).\
125 125  
126 -```
127 -[sitemap]
128 - filename = 'sitemap_index.xml'
129 -```
130 -Permet de renommer le fichier sitemap généré.\
122 + [sitemap]
123 + filename = 'sitemap_index.xml'
124 +
125 +Permet de renomer le fichier sitemap généré.\
131 131  Par défaut fichier sitemap.xml est généré automatiquement par HUGO.
132 132  Pour avoir des URL sans localhost un template a été créé pour remplacer celui par défaut et modifié avec `links_url` (dans /layouts/sitemap.xml).\
133 133  Il est possible de définire des paramètres globalement ou dans un front-matter pour désindexer une page ou changer la priorité d’indexation. (https:~/~/gohugo.io/templates/sitemap/)
134 134  
135 -```
136 -[params]
137 - noindex_taxonomy = ['tags', 'categories', 'feeds']
138 -```
130 + [params]
131 + noindex_taxonomy = ['tags', 'categories', 'feeds']
132 +
139 139  Permet d’exclure les pages générés par hugo non souhaité dans l’indexation. Ce paramètre agit à la fois en enlevant les liens dans le sitemap_index.xml ET en rajoutant une balise `meta` dans le `<head>` des pages concernées.
140 140  
141 -```
142 -[taxonomies]
143 - tag = 'tags'
144 -```
135 + [taxonomies]
136 + tag = 'tags'
137 +
145 145  Permet d’ajouter une taxonomie à HUGO  (à définir dans le front-matter des articles). Si on ne souhaite pas l’indexer, penser à le rajouter dans le noindex_taxonomy.
146 146  
147 147  - Pour activer les mathématiques dans markdown et pouvoir utiliser du texte en indice : https:~/~/gohugo.io/content-management/mathematics/
148 148  
149 -~#~# Date
150 -- Il n’est plus nécessaire d’écrire la date à la main. Hugo a maintenant une fonction pour l’écrire dans la bonne langue (en fonction de la langue de l’article).
151 -```
152 -# dans le front-matter généré par défaut (archetypes/default.md)
153 - datemanual = "~{~{ .Date | time.Format ":date\_full" }}"
154 -```
155 -Où :
156 -- `.Date` : est la date généré automatiquement par HUGO lors de la création de l’article
157 -- `| time.Format ":date\_full" }}` : transforme la date avec le format désiré (court ou long) et dans la bonne langue automatiquement (si nécessaire).
158 -
159 159  ~#~# URL and links
160 160  
161 -- Lorsqu’il s’agit de lien interne au site, il vaut mieux utiliser .RelPermalink (ou `~{~{ texte | relURL }}` ; qui vont fournir des URL relatives) que .Permalink pour que le site puisse changer d’url sans revoir tout le code.\
144 +- Lorsqu’il s’agit de lien interne au site, il vaut mieux utiliser .RelPermalink (ou ~{~{ texte | relURL }} ; qui vont fournir des URL relatives) que .Permalink pour que le site puisse changer d’url sans revoir tout le code.\
162 162   .Permalink va prendre l’url complète (absolute URL).\
163 163   .RelPermalink va prendre le chemin de l’url (et complèter automatiquement avec le nom de domaine, quel que soit le nom de domaine déployé).
164 164  - utiliser relURL si on doit l’ajouter à du texte avant. Utiliser .RelPermalink pour utiliser l’adresse relative toute seule. Idem avec absURL et .Permalink (?)
165 -- Il est possible de modifier l’url d’une page avec `url = " "` dans le front-matter (par exemple pour avoir une url dans la langue désirée).
166 166  
167 167  ~#~# search bar
168 168  
169 169  - utilisation de [pagefind](https:~/~/pagefind.app) et de ce [site](https:~/~/www.brycewray.com/posts/2022/07/pagefind-quite-find-site-search/#update-2022-07-31) (pour un lancement dans le dossier static et avoir le résultat du code en temps réel).
170 -- rajouter "[data-pagefind-body](https:~/~/pagefind.app/docs/indexing/#limiting-what-sections-of-a-page-are-indexed)" autour de `~{~{ .Content }}` dans single.html pour ne lister les articles (et pas la main page blog).
152 +- rajouter "[data-pagefind-body](https:~/~/pagefind.app/docs/indexing/#limiting-what-sections-of-a-page-are-indexed)" autour de "~{~{ .Content }}" dans single.html pour ne lister les articles (et pas la main page blog).
171 171  - pour customiser pagefind : https:~/~/pagefind.app/docs/ui-usage/#customising-the-styles. Vérifier le style lors d’une mise à jour.
154 +- Initialiser la barre de recherche du blog avec docker : todo !
172 172  
173 173  ~#~# Formulaire de contact HUGO
174 174  
... ... @@ -201,21 +201,8 @@
201 201  - https:~/~/discourse.gohugo.io/t/sending-emails/3739
202 202  - https:~/~/discourse.gohugo.io/t/is-it-possible-to-add-a-contact-form-to-a-site/1550/24
203 203  
204 -~#~# Internationalisation (i18n)
205 -
206 -- Le paramètre `~{~{  .Lang }}` permet de récupérer la langue actuelle du navigateur : utile pour que les liens du site reste dans la même langue au fur et à mesure de la navigation !
207 -- Le dossier i18n permet de traduire des mots ou phrase spécifique en déterminant des fichiers attribués à chaque langue (e.i : en.toml et fr.toml). Un mot clef donne la traduction demandé (e.i : dans le fichier fr.toml : `lireArticle = "Lire l’article"` ; dans le fichier en.toml : `lireArticle = "Read more"`).
208 -- HUGO reconnaît automatiquement les abrévations de langue (en, fr, de, es…). Il est possible de créer des fichiers reconnu et utilisé dans la bonne langue en les enregistrants ainsi : `home.fr.html` ; `home.en.html` ; `article.en.md` ; `article.fr.md`…
209 -- Il y a un ordre à respecter dans le fichier hugo.toml pour que les langues soient prises en compte (?). Dans les premières lignes sous baseURL.
210 -```
211 -baseURL = 'https:~/~/www.koevoo.tech'
212 -defaultContentLanguage = 'fr'
213 -defaultContentLanguageInSubdir = true
214 -title = 'Koevoo'
215 -```
216 -
217 -/!\ le param
218 -
219 219  ~#~# Trucs en plus pour HUGO
220 220  
221 221  - https:~/~/www.pierremorsa.com/post/2016-08-16-quelques-trucs-en-plus-pour-votre-site-hugo/
190 +
191 +