{{< parameter >}}

Descrição#


O código curto parameter permite mostrar uma parâmetro do site de acordo com o seu tipo.

Tipo Exibição
Map (Key/Value) Table
String list List
String Text

O parâmetro a ser exibido pode ser definido de duas formas:

O parâmetro exibido é lido como markdown e transformado de acordo a isso

Parâmetros#


Nome Tipo(nomeado/posicional) Descrição
posicional Parâmetro padrão do caminho a mostrar.
path nomeado Parâmetro específico do caminho a mostrar, relativo ao diretório data (o parâmetro deve ser definido num template de dados ).
PS: O parâmetro do caminho toma precedência sobre o parâmetro i18n.
i18n nomeado Parâmetro chave i18n a mostrar.

Exemplos#


Dadas as definições dos seguintes parâmetros:

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/en.yaml
- id: homepage_title
  translation: "Homepage"

Markdown Renderização

|

{{</* parameter "unknown" /*/>}}
{{</* parameter "logo" /*/>}}
images/logo.png
{{</* parameter "faviconmd" /*/>}}
{{</* parameter
    path="dir.exampleTemplate.exampleMap"
/*/>}}
exampleArray exampleString
  • 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"
/*/>}}
function keys
scShowInfo
  • Shift
  • i
{{</* parameter
    i18n="homepage_title"
/*/>}}
Home