{{< parameter >}}

Description#


Le shortcode parameter permet d’afficher un paramètre du site suivant son type.

TypeAffichage
Map (Clé/Valeur)Tableau
Liste de StringListe
StringTexte

Le paramètre à afficher peut être déclaré de deux manières différentes:

Le paramètre à afficher est interprété en markdown et converti en conséquence.

Paramètres#


NomType(nommé/positionnel)Description
positionnelChemin du paramètre standard du site à afficher.
pathnomméChemin du paramètre spécifique à afficher, relatif au dossier data (le paramètre doit être défini dans un fichier de type data ).
NB: Le paramètre path est prépondérant par rapport au paramètre i18n.
i18nnomméClé du paramètre i18n à afficher.

Exemples#


Considérant les définitions de paramètres suivant:

config.toml
[params]
  logo      = "images/logo.png"
  faviconmd = "![Favicon](/images/favicon.png)"
./data/dir/exampleTemplate.json
{
  "exampleMap": {
    "exampleArray": ["VAR1","VAR2","VAR3"],
    "exampleString": "STRING"
  }
}
./theme/data/themeParams.toml
[navbar]
  [navbar.shortcuts.1_info]
    keys = ["Shift","i"]
    function = "scShowInfo"
./theme/i18n/fr.yaml
- id: homepage_title
  translation: "Page d'accueil"

MarkdownRendu
{{</* parameter "inconnu" /*/>}}
{{</* parameter "logo" /*/>}}
images/logo.png
{{</* parameter "faviconmd" /*/>}}
Favicon
{{</* parameter
    path="dir.exampleTemplate.exampleMap"
/*/>}}
exampleArrayexampleString
  • VAR1
  • VAR2
  • VAR3
STRING
{{</* parameter
    path="dir.exampleTemplate.exampleMap.exampleArray"
/*/>}}
  • VAR1
  • VAR2
  • VAR3
{{</* parameter
    path="dir.exampleTemplate.exampleMap.exampleString"
/*/>}}
STRING
{{</* parameter
    path="themeParams.navbar.shortcuts.1_info"
/*/>}}
functionkeys
scShowInfo
  • Shift
  • i
{{</* parameter
    i18n="homepage_title"
/*/>}}
Page d’accueil