Merge pull request #484 from gethinode/shortcode

Refine abbr shortcode

.github/workflows/npm-publish.yml

@@ -31,8 +31,9 @@ jobs:
           cache: 'npm'
           cache-dependency-path: '**/package-lock.json'
   
-      - name: Perform clean install of npm
+      # [27/AUG/23] Adjusted from npm ci to prevent EBADPLATFORM error due to fsevents
-        run: npm ci
+      - name: Install npm
+        run: npm i
 
       - name: Publish package to npm
         run: npm publish

exampleSite/content/en/blog/bootstrap-elements.md

@@ -14,6 +14,16 @@ thumbnail:
 
 Hinode provides several shortcodes that wrap common Bootstrap components. Refer to the [official documentation]({{< param "links.hinode_docs" >}}) for more details.
 
+## Abbr
+
+As an example, the following shortcode displays the full text of an abbreviation on hover.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* abbr "CI/CD" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
 ## Accordion
 
 As an example, the following shortcode displays an accordion with three elements, of which the first element is expanded.
@@ -292,6 +302,16 @@ As an example, the following shortcodes render links in different formats.
 {{< /example >}}
 <!-- markdownlint-enable MD037 -->
 
+## Mark
+
+Use the `mark` shortcode to highlight text. The inner content is used as input.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+Use the mark shortcode to {{</* mark >}}highlight{{< /mark */>}} specific text.
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
 ## Nav
 
 As an example, the following shortcode displays a tab group with vertically aligned pills.
@@ -345,13 +365,33 @@ Loading...
 {{< /example>}}
 <!-- markdownlint-enable MD037 -->
 
+## Sub
+
+As an example, the following shortcode displays subscript text.
+
+<!-- markdownlint-disable MD037 -->
+{{< example >}}
+H{{</* sub 2 */>}}O is a liquid.
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Sup
+
+As an example, the following shortcode displays superscript text.
+
+<!-- markdownlint-disable MD037 -->
+{{< example >}}
+2{{</* sup 10 */>}} is 1024.
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
 ## Timeline
 
-As an example, the following shortcode displays a timeline with the file `data/timeline-en.yml` as data.
+As an example, the following shortcode displays a timeline with the file `data/timeline.en.yml` as data.
 
 <!-- markdownlint-disable MD037 -->
 {{< example lang="hugo" >}}
-{{</* timeline data="timeline-en" background="dark" */>}}
+{{</* timeline data="timeline" background="dark" */>}}
 {{< /example >}}
 <!-- markdownlint-enable MD037 -->
 

exampleSite/content/fr/blog/bootstrap-elements.md

@@ -0,0 +1,391 @@
+---
+author: Mark Dumay
+title: Éléments Bootstrap
+date: 2023-08-12
+description: Utilisez des shortcodes pour ajouter facilement des éléments Bootstrap courants.
+tags: ["bootstrap", "shortcode"]
+thumbnail:
+  url: img/boots.jpg
+  author: Nathan Dumlao
+  authorURL: https://unsplash.com/@nate_dumlao
+  origin: Unsplash
+  originURL: https://unsplash.com/photos/QLPWQvHvmII
+---
+
+Hinode propose plusieurs shortcodes qui enveloppent des composants Bootstrap courants. Consultez la [documentation officielle]({{< param "links.hinode_docs" >}}) pour plus de détails.
+
+## Accordéon
+
+À titre d'exemple, le shortcode suivant affiche un accordéon avec trois éléments, dont le premier élément est déplié.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* accordion */>}}
+  {{</* accordion-item header="Élément d'accordéon #1" show="true" */>}}
+    Il s'agit du contenu du corps du premier élément de l'accordéon. Il prend en charge le contenu HTML, s'il est activé dans le moteur de rendu goldmark. L'élément est affiché en ajoutant la valeur `show` à l'argument `class`.
+  {{</* /accordion-item */>}}
+  {{</* accordion-item header="Élément d'accordéon #2" */>}}
+    Il s'agit du contenu du corps du deuxième élément de l'accordéon.
+  {{</* /accordion-item */>}}
+  {{</* accordion-item header="Élément d'accordéon #3" */>}}
+    Il s'agit du contenu du corps du troisième élément de l'accordéon.
+  {{</* /accordion-item */>}}
+{{</* /accordion */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Alerte
+
+À titre d'exemple, le shortcode suivant affiche une alerte simple.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* alert color="danger" dismissible="true" */>}}
+    Une simple alerte de danger — vérifiez-la !
+{{</* /alert */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Badge
+
+Utilisez le shortcode "badge" pour afficher un badge avec un en-tête.
+
+<!-- markdownlint-disable MD037 -->
+{{< example >}}
+En-tête 1 {{</* badge title="Nouveau" */>}}
+{.h1}
+
+En-tête 2 {{</* badge title="Nouveau" */>}}
+{.h2}
+
+En-tête 3 {{</* badge title="Nouveau" */>}}
+{.h3}
+
+En-tête 4 {{</* badge title="Nouveau" */>}}
+{.h4}
+
+En-tête 5 {{</* badge title="Nouveau" */>}}
+{.h5}
+
+En-tête 6 {{</* badge title="Nouveau" */>}}
+{.h6}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Fil d'Ariane
+
+À titre d'exemple, le shortcode suivant affiche un fil d'Ariane pour la page du blog.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* breadcrumb path="blog" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Bouton
+
+À titre d'exemple, le shortcode suivant affiche une infobulle pour un bouton sombre avec un badge.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* button color="secondary" tooltip="Cliquez sur la boîte de réception pour voir vos messages non lus." href="#!" badge="99+" */>}}
+    Boîte de réception
+{{</* /button */>}}
+{{< /example>}}
+<!-- markdownlint-enable MD037 -->
+
+## Groupe de boutons
+
+À titre d'exemple, le shortcode suivant affiche un groupe de trois boutons.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* button-group aria-label="Basic example" */>}}
+  {{</* button color="primary" href="#!" */>}}Gauche{{</* /button */>}}
+  {{</* button color="primary" href="#!" */>}}Millieu{{</* /button */>}}
+  {{</* button color="primary" href="#!" */>}}Droite{{</* /button */>}}
+{{</* /button-group */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Carte
+
+À titre d'exemple, le shortcode suivant affiche une carte empilée qui renvoie à la page [à propos]({{< ref "about" >}}). Elle inclut un en-tête personnalisé.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* card path="about" padding="3" class="col-6 mx-auto" color="body-tertiary" header="publication" footer="none" /*/>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Groupe de cartes
+
+À titre d'exemple, le shortcode suivant affiche un groupe de cartes avec trois éléments.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* card-group padding="3" */>}}
+    {{</* card title="Framework Bootstrap" icon="fab bootstrap" */>}}
+        Créez des sites rapides et réactifs avec Bootstrap 5. Personnalisez facilement votre site
+        avec les fichiers source Sass.
+    {{</* /card */>}}
+    {{</* card title="Recherche en texte intégral" icon="fas magnifying-glass" */>}}
+        Recherchez votre site avec FlexSearch, une bibliothèque de recherche en texte intégral
+        avec zéro dépendances.
+    {{</* /card */>}}
+    {{</* card title="Outils de développement" icon="fas code" */>}}
+        Utilisez Node Package Manager pour automatiser le processus de construction et suivre
+        les dépendances.
+    {{</* /card */>}}
+{{</* /card-group */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Carrousel
+
+À titre d'exemple, le shortcode suivant affiche un carrousel centré avec trois slides, un rapport hauteur/largeur de 16:9 et une largeur relative de 67 % sur les grands écrans.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* carousel ratio="16x9" class="col-sm-12 col-lg-8 mx-auto" */>}}
+  {{</* img src="img/coffee.jpg" caption="slide 1" */>}}
+  {{</* img src="img/phone.jpg" caption="slide 2" */>}}
+  {{</* img src="img/dunes.jpg" caption="slide 3" */>}}
+{{</* /carousel */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Réduire
+
+À titre d'exemple, le shortcode suivant affiche un bouton qui, lorsqu'il est cliqué, déclenche l'apparition ou la disparition d'un panneau.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* button collapse="collapse-1" */>}}
+    Déclencher le panneau
+{{</* /button */>}}
+
+{{</* collapse id="collapse-1" class="p-3 border rounded bg-primary-subtle" */>}}
+    Un contenu de remplacement destiné au composant de repliement. Ce panneau est initialement masqué, mais il
+    sera révélé lorsque l'utilisateur active le déclencheur correspondant.
+{{</* /collapse */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Invite de commandes
+
+Utilisez le shortcode `command` pour générer un bloc avec un invite de commandes bash par défaut.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* command */>}}
+export MY_VAR=123
+{{</* /command */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+Spécifiez `user` et `host` pour ajouter le contexte de l'utilisateur à l'invite. De plus, utilisez `(out)` pour spécifier une ligne de sortie et utilisez `\` pour indiquer une continuation de ligne.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* command user="user" host="localhost" */>}}
+export MY_VAR=123
+echo "hello"
+(out)hello
+echo one \
+two \
+three
+(out)one two three
+echo "goodbye"
+(out)goodbye
+{{</* /command */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Documentation
+
+Utilisez le shortcode `docs` pour afficher le contenu d'un fichier `js`, `scss` ou `toml` :
+
+{{< docs name="theme-colors" file="config/_default/params.toml" >}}
+
+## Exemple
+
+Utilisez le shortcode `example` pour afficher un exemple de code et pour afficher un aperçu de la même entrée.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* command */>}}
+export MY_VAR=123
+{{</* /command */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Fichier
+
+Utilisez le shortcode `file` pour afficher et mettre en évidence le contenu complet d'un fichier d'entrée donné.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* file path="./config/_default/languages.toml" id="file-collapse-1" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Icon
+
+À titre d'exemple, les shortcodes suivants affichent une coche carrée, un logo de marque et une coche circulaire.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* fa square-check */>}}
+{{</* fab linkedin */>}}
+{{</* fas circle-check */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Image
+
+À titre d'exemple, le shortcode suivant affiche une image avec des coins arrondis et un ratio d'aspect de 21:9.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* image src="img/flowers.jpg" ratio="21x9" caption="Légende de l'image" class="rounded" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+À titre d'exemple, le shortcode suivant affiche une image vectorielle classique.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* image src="/img/logo_icon.svg" class="col-sm-6 col-lg-4" wrapper="text-center" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+À titre d'exemple, le shortcode suivant affiche une image vectorielle avec une référence de symbole.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* image src="/img/logo_var.svg#logo" class="col-sm-6 col-lg-4" wrapper="text-center" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Lien
+
+À titre d'exemple, les shortcodes suivants rendent des liens dans différents formats.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+
+- {{</* link hinode >}}Lien nommé avec les paramètres par défaut{{< /link */>}}
+- {{</* link name=hinode cue=false tab=false >}}Lien nommé s'ouvrant dans l'onglet actuel sans icône{{< /link */>}}
+- {{</* link name=hinode cue=true tab=true >}}Lien nommé s'ouvrant dans un nouvel onglet avec icône{{< /link */>}}
+- {{</* link hinode /*/>}}
+- {{</* link href="https://developer.mozilla.org" >}}Lien externe{{< /link */>}}
+- {{</* link "./projects/another-project" >}}Lien interne avec titre{{< /link */>}}
+- {{</* link url="projects/another-project" /*/>}}
+- {{</* link url="/projects/another-project" /*/>}}
+- {{</* link url="../projects/another-project" case=false /*/>}}
+- {{</* link "/about/" /*/>}}
+- {{</* link "/fr/about/" /*/>}}
+- {{</* link "/fr/about" >}}About (French){{< /link */>}}
+- {{</* link "#image" /*/>}}
+- {{</* link "components/#map" /*/>}}
+
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Navigation
+
+À titre d'exemple, le shortcode suivant affiche un groupe d'onglets avec des onglets alignés verticalement.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+  {{</* nav type="pills" vertical="true" */>}}
+    {{</* nav-item header="Élément de navigation #1" show="true" */>}}
+      Voici le contenu de navigation du premier élément. Il prend en charge le contenu HTML, s'il est
+      activé dans le moteur de rendu Goldmark. L'élément est affiché en ajoutant la valeur `show` à l'argument `class`.
+    {{</* /nav-item */>}}
+    {{</* nav-item header="Élément de navigation #2" */>}}
+      Voici le contenu de navigation du deuxième élément.
+    {{</* /nav-item */>}}
+    {{</* nav-item header="Élément de navigation #3" */>}}
+      Voici le contenu de navigation du troisième élément.
+    {{</* /nav-item */>}}
+  {{</* /nav */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Barre de navigation
+
+À titre d'exemple, le shortcode suivant affiche un en-tête de navigation clair.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* navbar id="navbar-sample" path="blog" color="primary" size="md" search="false" menus="sample" title="Marque" mode="false" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Publication
+
+À titre d'exemple, le shortcode suivant affiche un bouton de publication par défaut.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* release version="v0.14.1" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Indicateur de chargement
+
+À titre d'exemple, le raccourci suivant affiche un indicateur de chargement centré.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* spinner color="info" class="text-center" */>}}
+Chargement...
+{{</* /spinner */>}}
+{{< /example>}}
+<!-- markdownlint-enable MD037 -->
+
+## Chronologie
+
+À titre d'exemple, le shortcode suivant affiche une chronologie avec le fichier `data/timeline-fr.yml` en tant que données.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* timeline data="timeline-fr" background="dark" */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Notification
+
+À titre d'exemple, le shortcode suivant affiche un bouton qui, lorsqu'il est cliqué, déclenche le message de notification.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* button toast="toast-example-1" */>}}
+    Affiche la notifiaction #1
+{{</* /button */>}}
+
+{{</* button toast="toast-example-2" */>}}
+    Affiche la notifiaction #1
+{{</* /button */>}}
+
+{{</* toast id="toast-example-1" header="Premier titre" */>}}
+    Ceci est le premier message de notification. Il prend en charge le `markdown`.
+{{</* /toast */>}}
+
+{{</* toast id="toast-example-2" header="Deuxième titre" */>}}
+    Ceci est le deuxième message de notification. Il prend en charge le `markdown`.
+{{</* /toast */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
+## Infobulle
+
+À titre d'exemple, le shortcode suivant affiche une infobulle pour un lien hypertexte coloré.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* tooltip color="primary" title="Légende de l'infobulle" href="#!" */>}}Démonstration{{</* /tooltip */>}} d'une infobulle
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->

exampleSite/content/fr/blog/components.md

@@ -0,0 +1,39 @@
+---
+author: Mark Dumay
+title: Components
+date: 2023-07-21
+description: Utilisez des shortcodes pour ajouter des composants prédéfinis alimentés par des bibliothèques externes.
+tags: ["bootstrap", "shortcode"]
+thumbnail:
+  url: img/puzzle.jpg
+  author: Ryoji Iwata
+  authorURL: https://unsplash.com/@ryoji__iwata
+  origin: Unsplash
+  originURL: https://unsplash.com/photos/5siQcvSxCP8
+modules: ["katex", "leaflet"]
+---
+
+Hinode propose plusieurs shortcodes en plus des [éléments Bootstrap]({{< relref "bootstrap-elements" >}}) courants. Consultez la [documentation officielle]({{< param "links.hinode_docs" >}}) pour plus de détails.
+
+## Formule (KaTeX)
+
+À titre d'exemple, le markdown suivant affiche deux formules en utilisant la bibliothèque de composition typographique KaTeX.
+
+{{< example lang="markdown" >}}
+Voici une formule en ligne $-b \pm \sqrt{b^2 - 4ac} \over 2a$.
+
+Il s'agit d'une formule non en ligne:
+
+$$x = a_0 + \frac{1}{a_1 + \frac{1}{a_2 + \frac{1}{a_3 + a_4}}}$$  
+$$\forall x \in X, \quad \exists y \leq \epsilon$$
+{{< /example >}}
+
+## Map
+
+À titre d'exemple, le shortcode suivant affiche une carte interactive de la ville d'Amsterdam.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* map lat=52.377 long=4.90 zoom=13 popup="Gare centrale d'Amsterdam" popup-lat=52.378062 popup-long=4.900562 */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->

exampleSite/data/abbr.yml

@@ -0,0 +1,11 @@
+- id: css
+  long: "Cascading Style Sheets"
+
+- id: html
+  long: "HyperText Markup Language"
+
+- id: svg
+  long: "Scalable Vector Graphics"
+
+- id: ci/cd
+  long: "Continous Integration/Continuous Deployment"

exampleSite/data/timeline-fr.yml

@@ -0,0 +1,35 @@
+# This file holds all menu entries for the docs sidebar
+
+- title: Lancement de produit
+  icon: fas rocket
+  color: primary
+  date: 2023-07-01
+  url: https://github.com/gethinode/hinode/releases/tag/v0.15.2
+  content:
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Cupiditate ducimus officiis quod! Aperiam eveniet nam nostrum odit quasi ullam voluptatum.
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Cupiditate ducimus officiis quod! Aperiam eveniet nam nostrum odit quasi ullam voluptatum.
+
+- title: Prise en charge I18N
+  icon: fas globe
+  color: success
+  date: 2023-05-06
+  url: v0.14.0
+  content:
+    Lorem ipsum dolor sit amet.
+
+- title: Nouvelle fonctionnalité
+  icon: fas house
+  color: warning
+  date: 2023-02-04
+  url: v0.8.1
+  content:
+    Cupiditate ducimus officiis quod!
+
+- title: Version bêta
+  icon: fas heart
+  color: info
+  date: 2022-11-30
+  # url: v0.1
+  content:
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Cupiditate ducimus officiis quod! Aperiam eveniet nam nostrum odit quasi ullam voluptatum.
+    Lorem ipsum dolor sit amet, consectetur adipisicing elit. Cupiditate ducimus officiis quod! Aperiam eveniet nam nostrum odit quasi ullam voluptatum.

exampleSite/hugo_stats.json

@@ -2,6 +2,7 @@
   "htmlElements": {
     "tags": [
       "a",
+      "abbr",
       "body",
       "br",
       "button",
@@ -21,6 +22,7 @@
       "input",
       "li",
       "link",
+      "mark",
       "meta",
       "nav",
       "nil",
@@ -33,6 +35,8 @@
       "small",
       "span",
       "strong",
+      "sub",
+      "sup",
       "svg",
       "time",
       "title",
@@ -258,7 +262,7 @@
       "mt-3",
       "mt-5",
       "mt-auto",
-      "multi-docs-collapse-14",
+      "multi-docs-collapse-15",
       "multi-file-collapse-1",
       "mx-auto",
       "mx-md-2",
@@ -403,6 +407,7 @@
       "-theme",
       "-theme-collapsed",
       "TableOfContents",
+      "abbr",
       "accordion",
       "accordion-0",
       "accordion-0-heading-0",
@@ -413,7 +418,7 @@
       "accordion-0-item-2",
       "alert",
       "badge",
-      "body-docs-collapse-14",
+      "body-docs-collapse-15",
       "body-file-collapse-1",
       "breadcrumb",
       "btn-webshare",
@@ -429,7 +434,7 @@
       "docs",
       "example",
       "file",
-      "footer-docs-collapse-14",
+      "footer-docs-collapse-15",
       "footer-file-collapse-1",
       "formula-katex",
       "icon",
@@ -437,6 +442,7 @@
       "leaflet-map-0",
       "link",
       "map",
+      "mark",
       "nav",
       "nav-0",
       "nav-0-0",
@@ -450,6 +456,8 @@
       "navbar-sample-collapse",
       "release",
       "spinner",
+      "sub",
+      "sup",
       "timeline",
       "toast",
       "toast-container",

hugo_stats.json

@@ -16,6 +16,7 @@
       "link",
       "meta",
       "nav",
+      "ol",
       "p",
       "path",
       "script",
@@ -37,9 +38,12 @@
       "bg-primary",
       "bottom-0",
       "bottom-bar",
+      "breadcrumb",
+      "breadcrumb-item",
       "btn",
       "btn-close",
       "btn-primary",
+      "btn-social",
       "col",
       "col-12",
       "col-lg-2",
@@ -80,12 +84,17 @@
       "fa-circle-half-stroke",
       "fa-ellipsis",
       "fa-face-frown",
+      "fa-facebook",
       "fa-fw",
       "fa-github",
+      "fa-link",
       "fa-linkedin",
       "fa-medium",
       "fa-moon",
+      "fa-share-nodes",
       "fa-sun",
+      "fa-whatsapp",
+      "fa-x-twitter",
       "fab",
       "fas",
       "feature",
@@ -99,16 +108,21 @@
       "fs-3",
       "fw-30",
       "fw-bold",
+      "gap-2",
       "h-100",
+      "hstack",
       "img-fluid",
       "img-wrap",
       "invisible",
       "is-search",
       "justify-content-center",
+      "lead",
       "link-bg-footer",
       "link-secondary",
       "main-nav-toggler",
+      "mb-3",
       "mb-4",
+      "mb-5",
       "me-auto",
       "middle-bar",
       "min-vh-100",
@@ -147,11 +161,13 @@
       "px-4",
       "px-xxl-0",
       "py-2",
+      "py-3",
       "py-5",
       "py-md-1",
       "rounded",
       "row",
       "row-cols-1",
+      "row-cols-2",
       "row-cols-sm-3",
       "row-cols-sm-4",
       "search",
@@ -160,10 +176,13 @@
       "shadow",
       "svg-inline--fa",
       "switch-mode-collapsed",
+      "text-body-secondary",
       "text-center",
       "text-decoration-none",
+      "text-end",
       "text-secondary",
       "text-sm-start",
+      "text-uppercase",
       "theme-icon",
       "theme-icon-active",
       "toast",
@@ -178,9 +197,11 @@
     "ids": [
       "-theme",
       "-theme-collapsed",
+      "btn-webshare",
       "navbar-0-collapse",
       "toast-container",
-      "toast-copied-code-message"
+      "toast-copied-code-message",
+      "toast-message-email-4"
     ]
   }
 }

layouts/_default/list.html

@@ -1,4 +1,7 @@
 {{- define "main" -}}
+    <!-- Ignore empty content, see https://github.com/gohugoio/hugo/issues/11406 -->
+    {{- $content := "" -}}
+    {{- if .Content }}{{ $content = partial "utilities/ProcessContent" (dict "page" .Page "raw" .RawContent) }}{{ end -}}
     {{- partial "assets/section-list.html" (dict 
         "page" .
         "section" .Type
@@ -6,7 +9,7 @@
         "nested" .Params.Nested
         "title" (or .Title .Type)
         "description" .Description
-        "content" .Content
+        "content" $content
         "paginate" true)
     -}}
 {{- end -}}

layouts/_default/single.html

@@ -84,7 +84,8 @@
         {{ end -}}
     {{ end }}
 
-    {{ partial "utilities/ProcessContent" (dict "page" .Page "raw" .RawContent )}}
+    <!-- Ignore empty content, see https://github.com/gohugoio/hugo/issues/11406 -->
+    {{- if .Content }}{{ partial "utilities/ProcessContent" (dict "page" .Page "raw" .RawContent) }}{{ end -}}
 {{ end -}}
 
 {{ define "partials/footer.html" -}}

layouts/partials/assets/card.html

@@ -17,6 +17,7 @@
                     "publication", "tags", and "none" (default).
     "description"   Optional description of the card.
     "thumbnail"     Optional thumbnail image url, displayed on top or the left of the card.
+    "alt"           Optional alternate text for the thumbnail, uses "title" by default.
     "icon"          Optional Font Awesome icon, displayed on top or the left of the card.
     "orientation"   Optional placecement of the thumbnail or icon, either "stacked" (default), "horizontal",
                     "horizontal-sm" or "none".
@@ -82,6 +83,7 @@
 {{- end }}
 
 {{- $title := .title -}}
+{{- $alt := .alt -}}
 {{- $href := .href -}}
 {{- $description := .description -}}
 {{- $thumbnail := .thumbnail -}}
@@ -160,7 +162,7 @@
 {{- else -}}
     <div class="card {{ with $color }}bg-{{ . }} text-bg-{{ . }}{{ end }} {{ $class }}">
         {{- if $thumbnail -}}
-            {{- partial "assets/image.html" (dict "url" $thumbnail "ratio" "16x9" "outerClass" "card-img-wrap" "innerClass" "card-img-top" "title" $title) -}}
+            {{- partial "assets/image.html" (dict "url" $thumbnail "ratio" "16x9" "outerClass" "card-img-wrap" "innerClass" "card-img-top" "title" (or $alt $title)) -}}
         {{- else if $icon -}}
             <div class="p-{{ $padding }}">
                 {{- partial "assets/icon.html" (dict "icon" (printf "%s fa-4x text-secondary" $icon)) -}}

layouts/partials/utilities/ProcessContent.html

@@ -9,5 +9,5 @@
 {{- if site.Params.debugging.purgeHTMLComments -}}
     {{- $raw = replaceRE "<!--(.|\n)*?-->" "" $raw -}}
 {{- end -}}
-{{ $content := $raw | $page.RenderString | safeHTML }}
+{{ $content := emojify $raw | $page.RenderString }}
 {{ return $content }}

layouts/shortcodes/abbr.html

@@ -0,0 +1,68 @@
+<!-- 
+    Creates an HTML element that shows the long form of an abbrevitation. The abbreviation data is centrally stored in a
+    data file. By default, the shortcode uses "abbr.yaml" with translation support.
+    
+    The data file is expected to store key-value pairs, where "id" is the lower-case abbrevation and "long" its long
+    form. The following example illustrates this using YML:
+
+    - id: css
+      long: "Cascading Style Sheets"
+
+    The shortcode supports the following arguments:
+    "key"           Required case-insensitive key of the abbreviation. In shorthand notation, this is the first (and
+                    only) matched argument.
+    "data"          Optional filename of the abbrevation input. It defaults to "abbr.yaml" with translation support.
+                    You can omit the file extension. The file should reside in the "data" folder. The data supports
+                    language extensions. For example, "abbr.en.yaml" refers to the English translation of the
+                    abbrevation data. The filename "abbr.yaml" is used when no suitable translation is found.
+    "class"         Optional class attribute of the abbr element. For example, specify "initialism" for a slightly
+                    smaller font size.
+-->
+
+{{ $error := false }}
+
+{{ $key := "" }}
+{{- if .IsNamedParams }}{{ $key = .Get "key" }}{{ else }}{{ $key = .Get 0 }}{{ end }}
+
+{{ if not $key -}}
+    {{ errorf "Missing param 'key': %s" .Position -}}
+    {{ $error = true }}
+{{ end -}}
+
+{{- $data := .Get "data" | default "abbr" -}}
+{{ if not $data -}}
+    {{ errorf "Missing param 'data': %s" .Position -}}
+    {{ $error = true }}
+{{ end -}}
+
+{{- $class := .Get "class" -}}
+
+{{ if not $error }}
+    {{/* Try language-specific file first */}}
+    {{ $path := path.Join (path.Dir $data) (printf "%s.%s" (path.BaseName $data) .Page.Language.Lang) (path.Ext $data) }}
+    {{ $entries := index site.Data $path }}
+    {{/* Use exact provided path as backup */}}
+    {{ if not $entries -}}
+        {{ $entries = index site.Data $data }}
+    {{ end }}
+    {{ if not $entries -}}
+        {{ errorf "Invalid abbrevation data '%s': %s" $data .Position -}}
+        {{ $error = true }}
+    {{ end -}}
+
+    {{ $title := "" }}
+    {{ if not $error }}
+        {{ $elements := (where $entries "id" (lower $key)) }}
+        {{ if gt (len $elements) 0 }}
+            {{ $title = index (index $elements 0) "long" }}
+        {{ end -}}
+        {{ if not $title -}}
+            {{ errorf "Cannot find value for '%s': %s" $key .Position -}}
+            {{ $error = true }}
+        {{ end -}}
+    {{ end }}
+
+    {{ if not $error }}
+        <abbr {{ with $class }}class="{{ . }}"{{ end }} title="{{ $title }}">{{ $key }}</abbr>
+    {{ end }}
+{{ end }}

layouts/shortcodes/card.html

@@ -15,6 +15,7 @@
                     "publication", "tags", and "none" (default).
     "orientation"   Optional placecement of the thumbnail, either "stacked" (default), "horizontal", or "none".
     "thumbnail"     Optional thumbnail image url, displayed on top or the left of the card.
+    "alt"           Optional alternate text for the thumbnail, uses "title" by default.
     "icon"          Optional Font Awesome icon, displayed on top or the left of the card.
 -->
 
@@ -82,6 +83,7 @@
 
 {{ $description := trim .Inner " \r\n" | .Page.RenderString | safeHTML }}
 {{ $title := .Get "title" }}
+{{ $alt := .Get "alt" }}
 {{ $icon := .Get "icon" }}
 {{ $thumbnail := .Get "thumbnail" }}
 
@@ -99,6 +101,7 @@
             "description" $description
             "icon" $icon
             "thumbnail" $thumbnail
+            "alt" $alt
         ) -}}
     </div>
 {{ end -}}

layouts/shortcodes/kbd.html

@@ -0,0 +1,25 @@
+<!-- 
+    Adds a keyboard input element. The shortcode supports the following arguments:
+    "title"         Required title of the keyboard input. In shorthand notation, this is the first (and only) matched
+                    argument.
+    "class"         Optional class attributes of the keyboard input element.
+    "color"         Optional theme color of the element, either "primary", "secondary" (default), "success",
+                    "danger", "warning", "info", "light", "dark", "white", or "black".
+-->
+
+{{- $error := false -}}
+{{- $title := "" -}}
+{{- if .IsNamedParams }}{{ $title = .Get "title" }}{{ else }}{{ $title = .Get 0 }}{{ end }}
+{{- $class := .Get "class" -}}
+{{- $color := "" -}}
+{{- with .Get "color" }}{{ $color = . }}{{ end -}}
+{{- $supportedColors := slice "primary" "secondary" "success" "danger" "warning" "info" "light" "dark" "white" "black" -}}
+{{- if and $color (not (in $supportedColors $color)) -}}
+    {{- errorf "Invalid value for param 'color': %s" .Position -}}
+{{- end -}}
+
+{{- if not $title }}
+    {{ errorf "Missing title: %s" .Position -}}
+{{ else -}}
+    <kbd {{ if or $color $class }}class="{{ with $color }}text-bg-{{ . }}{{ end }}{{ with $class }} {{ . }}{{ end }}"{{ end }}>{{ $title | plainify }}</kbd>
+{{ end -}}

layouts/shortcodes/mark.html

@@ -0,0 +1,23 @@
+<!-- 
+    Highlights text by applying a background color. The shortcode supports the following arguments:
+    "color":        Optional theme color of the highlight, either "primary", "secondary", "success", "danger",
+                    "warning", "info", "light", "dark", "white" or "black". By default, the highlight uses the color of
+                    the HTML mark function.
+    "class":        Optional class attribute of the highlight element.
+-->
+
+{{- $error := false -}}
+{{ $color := .Get "color" -}}
+{{ $supportedColors := slice "primary" "secondary" "success" "danger" "warning" "info" "light" "dark" -}}
+{{ if and $color (not (in $supportedColors $color)) -}}
+    {{ errorf "Invalid value for param 'color': %s" .Position -}}
+    {{ $error = true -}}
+{{ end -}}
+
+{{- $class := .Get "class" -}}
+
+{{- if $color }}{{ $class = printf "%s text-bg-%s" $class $color }}{{ end -}}
+
+{{- if not $error -}}
+    <mark{{ with $class }} class="{{ . }}"{{ end }}>{{ trim .Inner " \r\n" | .Page.RenderString -}}</mark>
+{{- end -}}

layouts/shortcodes/sub.html

@@ -0,0 +1,7 @@
+<!-- 
+    Displays text as subscript, provided as unnamed argument.
+-->
+
+{{- $text := .Get 0 -}}
+
+<sub>{{ $text | .Page.RenderString -}}</sub>

layouts/shortcodes/sup.html

@@ -0,0 +1,7 @@
+<!-- 
+    Displays text as superscript, provided as unnamed argument.
+-->
+
+{{- $text := .Get 0 -}}
+
+<sup>{{ $text | .Page.RenderString -}}</sup>

layouts/shortcodes/timeline.html

@@ -3,13 +3,16 @@
     
     Show items ordered on a vertical timelime. The shortcode supports the following arguments:
     "data"          Required filename of the timeline input. You can omit the file extension. The file should reside in
-                    the "data" folder.
+                    the "data" folder. The data supports language extensions. For example, "timeline.en.yaml" refers to
+                    the English translation of the timeline data. The filename "timeline.yaml" is used when no suitable
+                    translation is found.
     "background"    Optional border color of the connector dots, defaults to the body background color. If set, uses a
                     subtle background color that is adaptive to the current color mode.
     "class"         Optional class attribute of the timeline's container.
 -->
 
 {{ $error := false }}
+{{- $page := .Page -}}
 
 {{- $data := .Get "data" -}}
 {{ if not $data -}}
@@ -17,7 +20,13 @@
     {{ $error = true }}
 {{ end -}}
 
-{{ $entries := index site.Data $data }}
+{{/* Try language-specific file first */}}
+{{ $path := path.Join (path.Dir $data) (printf "%s.%s" (path.BaseName $data) .Page.Language.Lang) (path.Ext $data) }}
+{{ $entries := index site.Data $path }}
+{{/* Use exact provided path as backup */}}
+{{ if not $entries -}}
+    {{ $entries = index site.Data $data }}
+{{ end }}
 {{ if not $entries -}}
     {{ errorf "Invalid timeline data '%s': %s" $data .Position -}}
     {{ $error = true }}
@@ -51,6 +60,7 @@
 <!-- Inline partial to render icon -->
 {{- define "partials/timeline-panel.html" -}}
     {{- $col := default 6 .col -}}
+    {{- $page := .page -}}
     {{- $content := .content -}}
     {{- $color := .color -}}
     {{- $title := .title -}}
@@ -79,7 +89,7 @@
                     {{ $datestr := (partial "utilities/date.html" (dict "date" $date "format" "long")) -}}
                     <p class="mb-0"><small class="text-body-secondary text-uppercase">{{ $datestr -}}</small></p>
                 {{ end }}
-                <p class="mt-3 mb-0">{{ $content | .Page.RenderString }}</p>
+                <p class="mt-3 mb-0">{{ $content | $page.RenderString }}</p>
             </div>
         </div>
     </div>    
@@ -90,11 +100,11 @@
     {{ range $index, $item := $entries }}
         <div class="row timeline timeline-{{ $item.color }} timeline-dot g-0 ">
             {{ if eq (mod $index 2) 1 }}
-                {{ partial "partials/timeline-panel.html" (dict "content" $item.content "color" $item.color "title" $item.title "badge" $item.badge "date" $item.date "url" $item.url "direction" "start") }}
+                {{ partial "partials/timeline-panel.html" (dict "page" $page "content" $item.content "color" $item.color "title" $item.title "badge" $item.badge "date" $item.date "url" $item.url "direction" "start") }}
                 {{ partial "partials/timeline-icon.html" (dict "icon" $item.icon "direction" "start") }}
             {{ else }}
                 {{ partial "partials/timeline-icon.html" (dict "icon" $item.icon "direction" "end") }}
-                {{ partial "partials/timeline-panel.html" (dict "content" $item.content "color" $item.color "title" $item.title "badge" $item.badge "date" $item.date "url" $item.url "direction" "end") }}
+                {{ partial "partials/timeline-panel.html" (dict "page" $page "content" $item.content "color" $item.color "title" $item.title "badge" $item.badge "date" $item.date "url" $item.url "direction" "end") }}
             {{ end }}
         </div>
         <div class="row timeline g-0 p-3"> </div>
@@ -106,7 +116,7 @@
     {{ range $index, $item := $entries }}
         <div class="row timeline-sm timeline-{{ $item.color }} timeline-dot g-0">
             {{ partial "partials/timeline-icon.html" (dict "icon" $item.icon "direction" "end" "col" 3) }}
-            {{ partial "partials/timeline-panel.html" (dict "content" $item.content "color" $item.color "title" $item.title "badge" $item.badge "date" $item.date "url" $item.url "direction" "end" "col" 9) }}
+            {{ partial "partials/timeline-panel.html" (dict "page" $page "content" $item.content "color" $item.color "title" $item.title "badge" $item.badge "date" $item.date "url" $item.url "direction" "end" "col" 9) }}
         </div>
         <div class="row timeline-sm g-0 p-3"> </div>
     {{ end }}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.19.0-alpha",
+  "version": "0.19.0-beta1",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",
@@ -70,13 +70,13 @@
     "autoprefixer": "^10.4.15",
     "cssnano": "^6.0.1",
     "cssnano-preset-advanced": "^6.0.1",
-    "eslint": "^8.47.0",
+    "eslint": "^8.48.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-n": "^16.0.2",
     "eslint-plugin-promise": "^6.1.1",
     "hugo-bin": "^0.113.0",
-    "markdownlint-cli2": "^0.9.0",
+    "markdownlint-cli2": "^0.9.2",
     "npm-run-all": "^4.1.5",
     "postcss-cli": "^10.1.0",
     "purgecss-whitelister": "^2.4.0",