aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/page/RenderString.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <[email protected]>2024-01-27 10:48:33 +0100
committerBjørn Erik Pedersen <[email protected]>2024-01-27 10:48:57 +0100
commit5fd1e7490305570872d3899f5edda950903c5213 (patch)
treef0cdc490a0942d720494c0044a64c6397d1ab6a5 /docs/content/en/methods/page/RenderString.md
parentfc7de7136acbcf0aef54ae8460c7702bc83709be (diff)
parent9b0050e9aabe4be65c78ccf292a348f309d50ccd (diff)
downloadhugo-5fd1e7490305570872d3899f5edda950903c5213.tar.gz
hugo-5fd1e7490305570872d3899f5edda950903c5213.zip
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
Diffstat (limited to 'docs/content/en/methods/page/RenderString.md')
-rw-r--r--docs/content/en/methods/page/RenderString.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/content/en/methods/page/RenderString.md b/docs/content/en/methods/page/RenderString.md
new file mode 100644
index 000000000..5782cd2b1
--- /dev/null
+++ b/docs/content/en/methods/page/RenderString.md
@@ -0,0 +1,51 @@
+---
+title: RenderString
+description: Renders markup to HTML.
+categories: []
+keywords: []
+action:
+ related:
+ - methods/page/RenderShortcodes
+ - functions/transform/Markdownify
+ returnType: template.HTML
+ signatures: ['PAGE.RenderString [OPTIONS] MARKUP']
+aliases: [/functions/renderstring]
+---
+
+```go-html-template
+{{ $s := "An *emphasized* word" }}
+{{ $s | .RenderString }} → An <em>emphasized</em> word
+```
+
+This method takes an optional map of options:
+
+display
+: (`string`) Specify either `inline` or `block`. If `inline`, removes surrounding `p` tags from short snippets. Default is `inline`.
+
+markup
+: (`string`) Specify a [markup identifier] for the provided markup. Default is the `markup` front matter value, falling back to the value derived from the page's file extension.
+
+Render with the default markup renderer:
+
+```go-html-template
+{{ $s := "An *emphasized* word" }}
+{{ $s | .RenderString }} → An <em>emphasized</em> word
+
+{{ $opts := dict "display" "block" }}
+{{ $s | .RenderString $opts }} → <p>An <em>emphasized</em> word</p>
+```
+
+Render with [Pandoc]:
+
+```go-html-template
+{{ $s := "H~2~O" }}
+
+{{ $opts := dict "markup" "pandoc" }}
+{{ $s | .RenderString $opts }} → H<sub>2</sub>O
+
+{{ $opts := dict "display" "block" "markup" "pandoc" }}
+{{ .RenderString $opts $s }} → <p>H<sub>2</sub>O</p>
+```
+
+[markup identifier]: /content-management/formats/#list-of-content-formats
+[pandoc]: https://www.pandoc.org/