aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/functions/transform/Markdownify.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/transform/Markdownify.md')
-rw-r--r--docs/content/en/functions/transform/Markdownify.md35
1 files changed, 35 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..b0be902ce
--- /dev/null
+++ b/docs/content/en/functions/transform/Markdownify.md
@@ -0,0 +1,35 @@
+---
+title: transform.Markdownify
+linkTitle: markdownify
+description: Renders markdown to HTML.
+categories: [functions]
+keywords: []
+menu:
+ docs:
+ parent: functions
+function:
+ aliases: [markdownify]
+ returnType: template.HTML
+ signatures: [transform.Markdownify INPUT]
+relatedFunctions: []
+aliases: [/functions/markdownify]
+---
+
+```go-html-template
+{{ .Title | markdownify }}
+```
+
+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 [`.Page.RenderString`] method, setting the `display` option to `block`.
+
+If the resulting HTML is two or more paragraphs, Hugo leaves the wrapping `p` tags in place.
+
+[`.Page.RenderString`]: /functions/renderstring/
+
+{{% note %}}
+Although the `markdownify` function honors [markdown render hooks] when rendering markdown to HTML, use the `.Page.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 %}}