gohugoio--hugo/docs/content/en/methods/page/RenderString.md

title, description, categories, keywords, params, aliases

title	description	categories	keywords	params	aliases
RenderString	Renders markup to HTML.			functions_and_methods returnType signatures template.HTML PAGE.RenderString [OPTIONS] MARKUP	/functions/renderstring

The RenderString method on a Page object renders markup to HTML.

{{ $s := "An *emphasized* word" }}
{{ $s | .RenderString }} → An <em>emphasized</em> word

Options

The RenderString method on a Page object accepts an options map.

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.

Examples

Render Markdown content to HTML in block display mode:

{{ $opts := dict "display" "block" }}
{{ $s | .RenderString $opts }} → <p>An <em>emphasized</em> word</p>

Render Pandoc content to HTML in block display mode:

{{ $s := "H~2~O" }}

{{ $opts := dict "markup" "pandoc" "display" "block" }}
{{ $s | .RenderString $opts }} → H<sub>2</sub>O