diff options
Diffstat (limited to 'docs/content/en/functions/collections/EchoParam.md')
-rw-r--r-- | docs/content/en/functions/collections/EchoParam.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/content/en/functions/collections/EchoParam.md b/docs/content/en/functions/collections/EchoParam.md new file mode 100644 index 000000000..7617eedd9 --- /dev/null +++ b/docs/content/en/functions/collections/EchoParam.md @@ -0,0 +1,40 @@ +--- +title: collections.EchoParam +linkTitle: echoParam +description: Prints a parameter if it is set. +categories: [functions] +keywords: [] +menu: + docs: + parent: functions +function: + aliases: [echoParam] + returnType: any + signatures: [collections.EchoParam COLLECTION KEY] +relatedFunctions: [] +aliases: [/functions/echoparam] +--- + +For example, consider this site configuration: + +{{< code-toggle file=hugo copy=false >}} +[params.footer] +poweredBy = 'Hugo' +{{< /code-toggle >}} + +To print the value of `poweredBy`: + +```go-html-template +{{ echoParam site.Params.footer "poweredby" }} → Hugo +``` + +{{% note %}} +When using the `echoParam` function you must reference the key using lower case. See the previous example. + +The `echoParam` function will be deprecated in a future release. Instead, use either of the constructs below. +{{% /note %}} + +```go-html-template +{{ site.Params.footer.poweredBy }} → Hugo +{{ index site.Params.footer "poweredBy" }} → Hugo +``` |