{{< snippet >}}

Descrição#

O código curto snippet permite escrever um fragmento de código definido a partir do conteúdo do código curto , ou de um arquivo modelo (“template”).

É possível definir fragmentos (“snippets”) organizados em guias (“tabs”). Para realizar isso, é necessário aninhar tantos códigos curtos tab quanto forem necessários no código curto principal snippet.

O conteúdo e os parâmetros definidos em um código curto tab toma precedência sobre as definições no código snippet principal. Caso todas as “tabs” compartilhem os mesmos parâmetros, é possível definir esses globalmente no código snippet principal (veja os exemplos embaixo).

Parâmetros#

Nome Tipo(nomeado/posicional) Descrição
file nomeado Caminho para o arquivo a incluir.
PS: O parâmetro arquivo toma precedência sobre o conteúdo do código curto.
type nomeado

Formato do arquivo a incluir.
Possíveis valores:

  • code
  • md
  • plaintext

PS: Caso não for especificado, o tipo padrão é code.
caption nomeado Legenda de fragmento de código.
PS: Parâmetro unicamente aplicável para um tipo de fragmento de código (code).
codelang nomeado Fragmento de linguagem de código.
PS: Parâmetro aplicável unicamente para um fragmento de tipo de código (code).
codeparam nomeado Fragmento de código highlight settings .
PS: Parâmetro aplicável unicamente para um tipo de fragmento de código (code).
title nomeado Tab title.
PS: Parâmetro aplicável unicamente para um código curto tab aninhado em código curto snippet.

Exemplos#

Markdown Renderização

|

{{</* snippet */>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /snippet */>}}

# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.

{{</* snippet
    type="code"
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /snippet */>}}

# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.

{{</* snippet
    type="md"
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /snippet */>}}

Olá mundo!#

*Sou um template reutilizável para incluir conteúdo numa página.

 
{{</* snippet
    type="plaintext"
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /snippet */>}}
# Olá mundo! --- *Sou um **template** **reutilizável** para incluir conteúdo numa página.
 
{{</* snippet
    file="templates/snippet.en.md"
    caption="I'm a legend"
/*/>}}
I'm a legend
# Hello, World!
---
*I am* **a reusable** ***template*** to include in a page content.

{{</* snippet
    file="templates/snippet.en.md"
    type="md"
    caption="I'm a legend"
/*/>}}
I'm a legend

Hello, World!#

I am a reusable template to include in a page content.

 
{{</* snippet
    file="templates/snippet.en.md"
    type="plaintext"
    caption="I'm a legend"
/*/>}}
I'm a legend
# Hello, World! --- *I am* **a reusable** ***template*** to include in a page content. 
{{</* snippet
    file="templates/snippet.go"
    caption="I'm a legend"
    codelang="go"
    codeparam="linenos=table,hl_lines=[1,3,\"5-7\"],linenostart=10"
/*/>}}
I'm a legend
10
11
12
13
14
15
16

package main

import "fmt"

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

{{</* snippet */>}}
{{</* tab
    title="code"
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /tab */>}}
{{</* tab
    title="md"
    type="md"
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /tab */>}}
{{</* tab
    title="plaintext"
    type="plaintext"
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /tab */>}}
{{</* /snippet */>}}

# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.

Olá mundo!#

*Sou um template reutilizável para incluir conteúdo numa página.

# Olá mundo! --- *Sou um **template** **reutilizável** para incluir conteúdo numa página.
 
{{</* snippet
    file="templates/snippet.go"
    type="md"
    caption="Sou uma legenda"
    codelang="go"
    codeparam="linenos=table,hl_lines=[1,3,\"5-7\"],linenostart=10"
*/>}}
{{</* tab
    title="first tab"
    type="code"
    caption="Sou outra legenda"
    codelang="go"
    codeparam="linenos=table,hl_lines=[1,3],linenostart=20"
/*/>}}
{{</* tab
    file="templates/snippet.en.md"
    title="second tab"
    codelang="md"
/*/>}}
{{</* tab
    title="third tab"
    type="plaintext"
    caption=""
*/>}}
# Olá mundo!
---
*Sou um **template** **reutilizável** para incluir conteúdo numa página.
{{</* /tab */>}}
{{</* /snippet */>}}
Sou outra legenda
20
21
22
23
24
25
26

package main

import "fmt"

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

Hello, World!#

I am a reusable template to include in a page content.

# Olá mundo! --- *Sou um **template** **reutilizável** para incluir conteúdo numa página.