mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-01 21:09:14 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
---
|
|
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/
|