mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 10:43:19 +00:00
8551ee2738
- supply named parameter if missing #260 - fix boolean parameter if given as string #261 - revise documentation
44 lines
876 B
Markdown
44 lines
876 B
Markdown
+++
|
|
description = "Get value of site params"
|
|
title = "Site param"
|
|
+++
|
|
|
|
The `siteparam` shortcode prints values of site params.
|
|
|
|
## Usage
|
|
|
|
While the examples are using named parameter you are free to use positional aswell.
|
|
|
|
{{< tabs groupId="shortcode-parameter">}}
|
|
{{% tab name="named" %}}
|
|
|
|
|
|
````go
|
|
{{%/* siteparam name="editURL" */%}}
|
|
````
|
|
|
|
{{% /tab %}}
|
|
{{% tab name="positional" %}}
|
|
|
|
````go
|
|
{{%/* siteparam "editURL" */%}}
|
|
````
|
|
|
|
{{% /tab %}}
|
|
{{< /tabs >}}
|
|
|
|
### Parameter
|
|
|
|
| Name | Position | Default | Notes |
|
|
|:---------------------|:---------|:-----------------|:------------|
|
|
| **name** | 1 | _<empty>_ | The name of the site param to be displayed. |
|
|
|
|
## Examples
|
|
|
|
### `editURL` from `config.toml`
|
|
|
|
```go
|
|
`editURL` value: {{%/* siteparam name="editURL" */%}}
|
|
```
|
|
|
|
`editURL` value: {{% siteparam name="editURL" %}}
|