{{< snippet >}}

Description#

Le shortcode snippet permet d’écrire un fragment de code, défini soit depuis le contenu du shortcode , soit depuis un fichier template.

De plus, il est possible de définir plusieurs fragments de code répartis dans différents onglets. Pour cela il suffit d’imbriquer autant de shortcode tab que d’onglet voulu dans un shortcode snippet parent.
Par exemple: afficher les commandes d’un CLI en fonction du système d’exploitation utilisé.

Le contenu ainsi que les paramètres définis dans un shortcode tab sont prépondérant par rapport à ceux définis dans le shortcode snippet parent. Si tout les onglets partagent les mêmes paramètres il est donc possible de les définir de manière globale dans le shortcode snippet parent (Cf. exemples ci-dessous).

Paramètres#

NomType(nommé/positionnel)Description
filenomméChemin du fichier à inclure.
NB: Le paramètre file est prépondérant par rapport au contenu du shortcode.
typenommé

Format du fichier à inclure.
Valeurs possibles:

  • code
  • md
  • plaintext

NB: Si non renseigné, le type par défaut est code.

captionnomméLégende de l’extrait de code.
NB: Paramètre uniquement applicable pour un extrait de type code.
codelangnomméLangage de l’extrait de code.
NB: Paramètre uniquement applicable pour un extrait de type code.
codeparamnomméParamètres de surlignage de l’extrait de code.
NB: Paramètre uniquement applicable pour un extrait de code de type code.
titlenomméTitre de l’onglet.
NB: Paramètre uniquement applicable pour un shortcode tab imbriqué dans un shortcode snippet.

Exemples#

MarkdownRendu
{{</* snippet */>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /snippet */>}}

# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.

{{</* snippet
    type="code"
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /snippet */>}}

# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.

{{</* snippet
    type="md"
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /snippet */>}}

Hello, World!#

Je suis un template réutilisable à inclure dans le contenu d’une page.

{{</* snippet
    type="plaintext"
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /snippet */>}}
# Hello, World! --- *Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* snippet
    file="templates/snippet.fr.md"
    caption="Je suis une légende"
/*/>}}
Je suis une légende
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.

{{</* snippet
    file="templates/snippet.fr.md"
    type="md"
    caption="Je suis une légende"
/*/>}}
Je suis une légende

Hello, World!#

Je suis un template réutilisable à inclure dans le contenu d’une page.

{{</* snippet
    file="templates/snippet.fr.md"
    type="plaintext"
    caption="Je suis une légende"
/*/>}}
Je suis une légende
# Hello, World! --- *Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* snippet
    file="templates/snippet.go"
    caption="Je suis une légende"
    codelang="go"
    codeparam="linenos=table,hl_lines=[1,3,\"5-7\"],linenostart=10"
/*/>}}
Je suis une légende
10
11
12
13
14
15
16

package main

import "fmt"

func main() {
  fmt.Println("Hello, World!")
}

{{</* snippet */>}}
{{</* tab
    title="code"
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /tab */>}}
{{</* tab
    title="md"
    type="md"
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /tab */>}}
{{</* tab
    title="plaintext"
    type="plaintext"
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /tab */>}}
{{</* /snippet */>}}

# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.

Hello, World!#

Je suis un template réutilisable à inclure dans le contenu d’une page.

# Hello, World! --- *Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* snippet
    file="templates/snippet.go"
    type="md"
    caption="Je suis une légende"
    codelang="go"
    codeparam="linenos=table,hl_lines=[1,3,\"5-7\"],linenostart=10"
*/>}}
{{</* tab
    title="first tab"
    type="code"
    caption="Je suis une autre légende"
    codelang="go"
    codeparam="linenos=table,hl_lines=[1,3],linenostart=20"
/*/>}}
{{</* tab
    file="templates/snippet.fr.md"
    title="second tab"
    codelang="md"
/*/>}}
{{</* tab
    title="third tab"
    type="plaintext"
    caption=""
*/>}}
# Hello, World!
---
*Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.
{{</* /tab */>}}
{{</* /snippet */>}}
Je suis une autre légende
20
21
22
23
24
25
26

package main

import "fmt"

func main() {
  fmt.Println("Hello, World!")
}
Je suis une légende

Hello, World!#

Je suis un template réutilisable à inclure dans le contenu d’une page.

# Hello, World! --- *Je suis* **un template** ***réutilisable*** à inclure dans le contenu d'une page.