hugo-theme-relearn/exampleSite/content/shortcodes/siteparam.en.md
2021-10-24 13:03:38 +02:00

33 lines
No EOL
689 B
Markdown

+++
description = "Get value of site params variables in your page"
title = "Site param"
+++
The `siteparam` shortcode is used to help you print values of site params.
## Usage
````go
{{%/* siteparam <string> */%}}
````
The first required parameter is the name of the site param to be displayed.
## Examples
For instance, in this current site, the `editURL` variable is used in `config.toml`
```toml
[params]
editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
```
Use the `siteparam` shortcode to display its value.
```go
`editURL` Value : {{%/* siteparam "editURL" */%}}
```
is displayed as
`editURL` Value : {{% siteparam "editURL" %}}