diff options
Diffstat (limited to 'docs/content/en/functions/transform/Markdownify.md')
-rw-r--r-- | docs/content/en/functions/transform/Markdownify.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/content/en/functions/transform/Markdownify.md b/docs/content/en/functions/transform/Markdownify.md new file mode 100644 index 000000000..8fb1e48ce --- /dev/null +++ b/docs/content/en/functions/transform/Markdownify.md @@ -0,0 +1,31 @@ +--- +title: transform.Markdownify +description: Renders markdown to HTML. +categories: [] +keywords: [] +action: + aliases: [markdownify] + related: + - methods/page/RenderString + - methods/page/RenderShortcodes + returnType: template.HTML + signatures: [transform.Markdownify INPUT] +aliases: [/functions/markdownify] +--- + +```go-html-template +<h2>{{ .Title | markdownify }}</h2> +``` + +If the resulting HTML is a single paragraph, Hugo removes the wrapping `p` tags to produce inline HTML as required per the example above. + +To keep the wrapping `p` tags for a single paragraph, use the [`RenderString`] method on the `Page` object, setting the `display` option to `block`. + +[`RenderString`]: /methods/page/renderstring/ + +{{% note %}} +Although the `markdownify` function honors [markdown render hooks] when rendering markdown to HTML, use the `RenderString` method instead of `markdownify` if a render hook accesses `.Page` context. See issue [#9692] for details. + +[markdown render hooks]: /templates/render-hooks/ +[#9692]: https://github.com/gohugoio/hugo/issues/9692 +{{% /note %}} |