Koevoo's Home

1

# Notes HUGO

2

3

~#~# Images

4

5

intégrer image css "background: url()" plutôt que src dans le html

6

7

- plus facile pour le responsive

8

- mieux pour le seo.

9

- meilleur gestion de la taille avec center/cover (?) (actuellement il faut que les images soient en 400x250 px). Pour ça utiliser url() et afficher les images depuis le css plutôt que depuis le html via src (?).

10

- avec l’utilisation du shortcode par défaut figure `~{~{< figure src="/mon-image.jpg" link="https:~/~/koevoo.tech" alt="" width=100% >}}`\

11

L’option `title=""` ne crée pas la balise `<title>` dans le html, mais rajoute un titre h4 comme légende à la photo.

~#~# Summary

- À définir dans le front-matter du fichier .md (texte indépendant qui n’est pas un extrait du début de l’article)

~#~# <title>

- ~{~{ 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

- Utilisé en complément de `pluralizeListTitles = false ; titleCaseStyle = 'firstupper'` définie dans hugo.toml (cf ci-dessous)

22

23

~#~# shortcode et CSS en markdown

24

25

- https:~/~/gohugo.io/templates/shortcode/

26

- Défini dans le readme

27

- Se trouve dans le dossier /shortcodes

~#~# backtick

- 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

~#~# Liste à puces

- Dans un article, l’utilisation de markdown pour les listes à puces numérotées (e.i. 1. 2. 3.) va générer des balises `<ol>` par HUGO.\

36

Dans le fichier blog.css la règle :

```

ol {

list-style-position: inside;

}

```

Permet de garder les puces alignées avec le texte.

45

46

/!\ Nécéssiter d’utiliser le shortcode `{.space}` entre les paragraphes pour ne pas laisser d’espace entre 2 blocs de texte (sans quoi le texte va à la ligne sous le numéro et ne reste pas sur la même ligne).

- La régle :

```

ul {

list-style: none;

}

```

empêche les autres formes de puces (nécessaire pour ne pas faire apparaître de puces devant les tags qui utilisent aussi des balises `<ul>`).\

57

Nécessiter de coller une puce manuellement si un visuel de puces autres que des numéros est souhaité.

~#~# SEO

- ~*~*minification~*~* : put css and js in folder assets.\

62

use this lines in head:

63

64

`~{~{ $style := resources.Get "styles.css" | minify | fingerprint }}`\

65

`<link rel="stylesheet" href="~{~{ $style.Permalink }}">`

66

67

with integrity to check if the file is the good one :\

68

ex:

69

70

`~{~{ $script := resources.Get "js/main.js" | minify | fingerprint }}`\

71

`<script src="~{~{ $script.Permalink }}" integrity="~{~{ $script.Data.Integrity }}"></script>`

72

73

(source : https:~/~/hugo-mini-course.netlify.app/sections/optimizing/css/#minify)

74

75

```

76

In case of HUGO not recognize "assets" folder for default css an js (work fine in "static" folder) :

77

78

2 answers for this function (not bug) :

79

- Assets can be used in pipes, static can’t. So you best put files that need some kind of modification in assets: CSS you want to be fingerprinted and minimized, for example. static is for resources that are … static. Like images and fonts.

80

- files in static are always pulled on a build, where assets only when needed/requested by the code/function/module/shortcode etc. You may have 10 versions of a file in assets and call for 1 only in code, then folder on the build website will serve only 1 file (links to 9 others will results in file not found). When you got 10 versions of a file in static on the build you will have all 10 files served (accessible).

81

82

links :

83

https:~/~/discourse.gohugo.io/t/difference-between-asset-and-static-folder/41203

84

https:~/~/discourse.gohugo.io/t/are-assets-and-static-folders-interchangeable/36778/2

85

The HUGO documentation for this :

86

https:~/~/gohugo.io/hugo-pipes/introduction

87

88

[RESOLVE] : It works with the use of minify for call css/js, when you put css and js in respective folder in assets folder (but you need to reconstruct website each time you modify files. It useful for developpement to keep css/js in static folder).

```

- ~*~*robots.txt~*~*

set enableRobotsTXT = true in hugo.toml

93

94

- ~*~*sitemap.xml~*~* : automatiquement généré par HUGO : https:~/~/gohugo.io/templates/sitemap/ (voir la configuration du fichier hugo.toml ci-dessous: [sitemap])

95

96

- ~*~*Meta Tags~*~* : todo (?) with link : https:~/~/hugo-mini-course.netlify.app/sections/optimizing/seo/ ; création d’une balise meta pour exclure des pages (tags) de l’indexation des moteurs de recherche (cf : hugo.toml ci-dessous).

97

98

- ~*~*how to compress image~*~* : https:~/~/hugo-mini-course.netlify.app/sections/optimizing/images/

~#~# hugo.toml

pluralizeListTitles = false

103

titleCaseStyle = 'firstupper'

104

105

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)

106

107

[markup.goldmark.renderer]

108

unsafe= true

109

110

est utile pour permettre le rendu markdown dans les shortcodes (en utilisant %).

111

112

[markup.goldmark.parser.attribute]

block = true

title = true

Pour débloquer la fonction {.class} pour utiliser du css dans le markdown via HUGO.

117

118

baseURL = 'https:~/~/preprod.koevoo.fr'

119

[params]

120

links_url = "https:~/~/preprod.koevoo.fr"

121

122

À 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).\

123

Ex : `href="~{~{ .Site.Params.links_url | safeURL }}~{~{ .RelPermalink | safeURL }}"`\

124

Le paramètre baseURL ne fonctionne pas et renvoie `localhost` (lié à l’utilisation du serveur d’HUGO qui ne prend pas en compte `baseURL` ?).

125

Est également utile pour générer les liens dans le template sitemap.xml (/layouts/sitemap.xml).\

126

127

[sitemap]

128

filename = 'sitemap_index.xml'

129

130

Permet de renomer le fichier sitemap généré.\

131

Par défaut fichier sitemap.xml est généré automatiquement par HUGO.

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

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

135

[params]

136

noindex_taxonomy = ['tags', 'categories', 'feeds']

137

138

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.

[taxonomies]

tag = 'tags'

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.

144

145

- Pour activer les mathématiques dans markdown et pouvoir utiliser du texte en indice : https:~/~/gohugo.io/content-management/mathematics/

~#~# URL and links

- 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.\

150

.Permalink va prendre l’url complète (absolute URL).\

151

.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é).

152

- utiliser relURL si on doit l’ajouter à du texte avant. Utiliser .RelPermalink pour utiliser l’adresse relative toute seule. Idem avec absURL et .Permalink (?)

~#~# search bar

- 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).

157

- 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).

158

- pour customiser pagefind : https:~/~/pagefind.app/docs/ui-usage/#customising-the-styles. Vérifier le style lors d’une mise à jour.

159

- Initialiser la barre de recherche du blog avec docker : todo !

160

161

~#~# Formulaire de contact HUGO

162

163

~#~#~#~# Configuration de n8n

164

165

- Utilisation de n8n pour le formulaire.

166

- Ce sont les « Field Label » qui sont utilisés comme entré dans le json produit. Comment faire si le field label contient des espaces ?

167

- Dans le nœud Email, dans Email Format choisir "text" puis cliquer sur "Expression" pour rentrer le texte et le code json

168

169

exemple avec le formulaire koevoo :

170

171

```

172

Nom : ~{~{$json.Nom}}

173

Prénom : ~{~{$json.Prénom}}

174

Société : ~{~{$json.Société}}

175

Email : ~{~{$json.Email}}

176

Téléphone : ~{~{$json.Téléphone}}

177

Message : ~{~{$json.Message}}

178

179

180

Backup : ~{~{JSON.stringify($json)}}

181

```

182

183

- En utilisant un nœud "webhook" plutôt qu’un "Form Trigger" il est possible d’utiliser son propre HTML/CSS pour le formulaire et capturer les infos fourni dans n8n.

184

185

~#~#~#~# Autres possibilités de formulaires :

186

187

ressources :

188

- https:~/~/ktarila.com/blog/1-contact-forms-for-static-generated-sites/

189

- https:~/~/www.pierremorsa.com/post/2017-11-13-ajouter-formulaire-hugo/

190

- https:~/~/medium.com/@irishgeoff22/crafting-a-contact-form-using-the-hugo-static-website-generator-d043e5c2ca88