mirror
/
hugo
mirror of https://github.com/gohugoio/hugo
1
0
Fork 0
Code Issues
hugo/docs/content/en/methods/page/RenderString.md

1.4 KiB
Raw Permalink Blame History

title description categories keywords action aliases
RenderString Renders markup to HTML.
related returnType signatures
methods/page/RenderShortcodes
functions/transform/Markdownify
template.HTML
PAGE.RenderString [OPTIONS] MARKUP
/functions/renderstring 
{{ $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:

{{ $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:

{{ $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>