Cela fait longtemps que je trouve que le générateur de sites statiques Pelican est à remplacer. Deux problèmes m’y ont poussés :

  1. Les flux RSS/Atom sont tronqués, obligeant le lecteur à visiter mon site.
  2. La prise en charge de l’internationalisation est une bidouille au lieu d’une fonctionnalité à part entière.

Par ailleurs, c’est surtout pour cette seconde raison que je ne me suis pas intéressé à Jekyll.

Hugo

Générer un site avec Hugo est trivial. La documentation du projet fait son travail et écrire un article consiste à créer un fichier texte avec quelques balises.

Là où cela devient plus complexe, c’est de trouver un thème qui à la fois répond à son besoin en termes de structuration de l’information, à jour des dernières modifications apportées par Hugo et prenant en charge l’internationalisation.

Ma recommandation est de se focaliser sur les deux premiers points. Le dernier est finalement assez facile à résoudre.

Globalement, les liens dans les thèmes posent souvent problèmes, il faut veiller à quelques points décrits dans cette page de la documentation de l’internationalisation avec Hugo

Vraiment, lisez la documentation.

Activation du thème Hyde

Tout d’abords, voici la version d’Hugo que j’utilise :

Hugo Static Site Generator v0.49 linux/amd64 BuildDate: 2018-09-24T10:03:17Z
  1. Créons le nouveau site : hugo new site i18n-hyde
  2. Cela créera un dossier i18n-hyde avec la structure par défaut.
  3. Téléchargez le thème hyde
  4. Déplacez-le dans le dossier themes de votre site, dans un dossier appelé hyde.
  5. Modifiez le fichier de configuration (par défaut config.toml), renseignez le thème utilisé theme = "hyde".
  6. Créez un nouvel article : hugo new posts/demo.md
  7. Modifiez-le en ajoutant le contenu de votre choix et retirez le statut de brouillon.
  8. Lancez la génération du site via : hugo server -D

Activer l’internationalisation dans Hugo

Bon, maintenant ajoutons un peu d’internationalisation, modifiez le fichier de configuration :

  1. Modifiez la langue par défaut :
    • languageCode = "fr"
    • Description de la documentation : a string representing the language as defined. This is mostly used to populate the RSS feeds with the right language code.
  2. Indiquez à Hugo que tout contenu sans langue est en Français par défaut :
    • DefaultContentLanguage = "fr"
    • Description de la documentation : Content without language indicator will default to this language.
  3. Indiquez à Hugo que vos articles sont désormais dans un sous-dossier du nom de la langue :
    • defaultContentLanguageInSubdir = true
    • Description de la documentation : Render the default content language in subdir, e.g. content/en/. The site root / will then redirect to /en/.
  4. Dans le dossier de votre site, créez un dossier fr dans content.
  5. Déplacez le dossier posts dans ce dossier fr.

Vous l’avez probablement déjà deviné, les autres langues seront dans le même dossier. Notre petit article de tout à l’heure est désormais accessible à l’adresse suivante : http://localhost:1313/fr/posts/demo/

Le contenu

Traduisons notre article en plusieurs langues

Allez dans le dossier content, copiez votre dossier fr en ar pour l’Arabe, oc pour l’Occitan, en pour Anglais et ro pour le Roumain.

Facile, dans le dossier content, utilisez cette formule :

for i in ar oc en ro; do cp -R fr $i ; done

Pour mieux tester, prenez une minute pour mettre du vrai contenu, tant le titre que le corps de l’article en vous servant d’un service de traduction (ou en trouvant du contenu dans ces langues, par exemple sur Wikipédia).

Générez à nouveau le site : hugo server -D

Essayez un peu :

Ça fonctionne sans soucis. C’est un bon début.

Maintenant regardons le reste du site :

  • L’accueil liste tous les articles indifféremment de la langue
  • L’accueil en français liste bien uniquement bon article (idem pour les autres langues) mais la mise en forme est nulle.

En fait, c’est là qu’on voit le piège, on pense que ça fonctionne mais non. Hugo voit des dossiers avec des articles, et génère simplement les pages en regard.

Vous pouvez le constater, car lors de la génération du site, lorsque vous saisissez hugo server -D, vous n’avez qu’une colonne pour les pages correspondantes à la langue FR.

Bilan d’étape

On a donc un ersatz d’internationalisation, cela correspond à ce qu’on pourrait avoir avec n’importe quel générateur de site statique, tels Pelican, Jekyll ou Antora.

Ce qu’on souhaite avoir en plus, ce sont tous les petits détails qui permettent une prise en charge native des URL locales, des liens internes, des sitemaps, des balises HTML LANG, etc.

Ajouter l’internationalisation au thème

Débuter par prévenir Hugo

Hugo a besoin de savoir quelles langues sont à activer. Ici je fais de façon bourrin une configuration donnant un titre traduit et le lieu où est stocké le contenu de chaque langue.

[languages]
  [languages.fr]
    title = "Mon démonstrateur d’internationalisation"
    contentDir = "content/fr"
  [languages.ar]
    title = "مُستعرِضي للتدويل"
    contentDir = "content/ar"
  [languages.oc]
    title = "Lo meu demostrator d’internacionalizacion"
    contentDir = "content/oc"
  [languages.en]
    title = "My internationalization demonstrator"
    contentDir = "content/en"
  [languages.ro]
    title = "Demonstratorul meu de internaționalizare"
    contentDir = "content/ro"

Relancez maintenant hugo server -D, vous n’avez qu’une colonne pour les pages correspondantes à la langue FR.

On voit bien une colonne par langue, c’est bon signe :

Catégorie AR OC EN RO FR
Pages 10 10 10 10 10
Paginator pages 0 0 0 0 0
Non-page files 0 0 0 0 0
Static files 6 6 6 6 6
Processed images 0 0 0 0 0
Aliases 1 1 1 1 1
Sitemaps 2 1 1 1 1
Cleaned 0 0 0 0 0

Accéder au site local en remplaçant fr par ar, oc, en ou ro montre bien le contenu dans la langue locale. C’est bien !

Liste des corrections à apporter

Il reste encore tout un tas de petits détails à apporter :

  1. le titre principal du site (celui à gauche) ne comprends pas la langue
  2. il faudrait ajouter un bouton pour lire le contenu dans une autre langue
  3. utiliser les URL dans la langue des articles
  4. les liens internes sont-ils tous cohérents vis-à-vis de la langue courante
  5. la balise HTML LANG n’est pas définie

Correction 1 : lien principal

Visiblement, les thèmes Hugo utilisent souvent la variable .Site.BaseURL. C’est l’adresse fixe définie à la première ligne de notre fichier de configuration.

Une simple commande indique où cette variable est utilisée : grep -R Site.BaseURL *

  • themes/hyde/layouts/partials/sidebar.html
    • C’est notre menu de gauche → à corriger
  • themes/hyde/layouts/partials/head.html
    • C’est pour nos fichiers statiques → à conserver tel quel
  • themes/hyde/layouts/404.html
    • C’est pour le bouton retour en cas de page 404 → à conserver tel quel

La correction est simple, il suffit de remplacer {{ .Site.BaseURL }} par {{ .Site.BaseURL | relLangURL }}.

On commence à toucher du bout du doigt ce que veut signifie « prendre en charge l’internationalisation ».

Correction 2 : lister les langues

Une simple liste nous permettra de lister les articles traduits :

{{ if .IsTranslated }}
<ul class="nav-list">
    {{ range .Translations }}
    <li>
        <a href="{{ .Permalink }}">{{ .Language.LanguageName }}</a>
    </li>
    {{ end}}
</ul>
{{ end }}

On ajoutera celle-ci à la fin des modèles suivants :

  • dans l’article : themes/hyde/layouts/_default/single.html
  • dans le menu latéral : themes/hyde/layouts/partials/sidebar.html

On remarque qu’on utilise le code {{ .Language.LanguageName }}. Pour une raison que j’ignore, nous devons ajouter à notre fichier de configuration la variable languageName pour chacune de nos langues.

[languages]
  [languages.fr]
    title = "Mon démonstrateur d’internationalisation"
    contentDir = "content/fr"
    languageName = "Français"
  [languages.ar]
    title = "بلدي تدويل المتظاهر"
    contentDir = "content/ar"
    languageName = "العربية"
  [languages.oc]
    title = "El meu manifestant d’internacionalització"
    contentDir = "content/oc"
    languageName = "occitan"
  [languages.en]
    title = "My internationalization demonstrator"
    contentDir = "content/en"
    languageName = "English"
  [languages.ro]
    title = "Demonstratorul meu de internaționalizare"
    contentDir = "content/ro"
    languageName = "Română"

En actualisant, on constate le bon fonctionnement. C’est bien !

Correction 3 : utilisez la langue locale dans l’URL

Il suffit d’ajouter deux lignes à la configuration :

[permalinks]
   posts = "/:year/:month/:title/"

Et voilà ! Notre page de démo a donc les adresses suivantes :

Correction 4 : les liens internes sont-ils tous cohérents ?

De la même façon qu’avec le baseURL utilisé pour le menu latéral, vérifiez que les liens pointant vers les catégories ou tags de votre contenu sont cohérents.

Correction 5 : la balise HTML LANG

Pour démarrer, voici la recommandation du W3C et l’explication sur pourquoi utiliser cette balise lang.

Une simple commande indique où la base html est déclarée : grep -R "html " *

Il n’y a qu’une page de modèle : themes/hyde/layouts/partials/head.html.

On ajoutera simplement lang="{{ .Site.Language.Lang }}" xml:lang="{{ .Site.Language.Lang }}" à notre balise HTML.

Bonus : nettoyer le thème

Pensez à virer toutes les choses nocives pour le web.

Dans ce thème on trouve une référence à Google Analytics et Disqus, mais surtout un appel systématique à Google Fonts.

Les fichiers à modifier sont les suivants, ça prend deux minutes et le web ne s’en portera que mieux :

  • themes/hyde/layouts/_default/baseof.html
  • themes/hyde/layouts/_default/single.html
  • themes/hyde/layouts/partials/head.html
  • themes/hyde/layouts/partials/head_fonts.htm

Bilan

Nous avons maintenant un site statique et multilingue :)

Merci Hugo.