mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
26f1458a2d
bd0e15bb6 Optimised images with calibre/image-actions 59830ea44 Remove comments from quickstart code samples 348821b5d Remove image-actions 1cbbd26a9 Update index.md bcf3de764 Update index.md fcf17e6ef Release 0.62.1 0956bde21 Merge branch 'temp621' 28d604756 releaser: Add release notes to /docs for release of 0.62.1 c895f12e7 Fix statement about version installed with apt-get (#854) e96928e38 Updated quickstart to split theme download and theme config add into separate blocks (#967) e099c1ad6 changed ".Title" to ".URL" (#972) bea71280d Fix small typing error (#1001) 9c28c422e Correct hyperlink for 'markdownify' function cf3844a06 Corrected small conjugation mistake (#996) 8b9c1d4f2 Added remarks about additional parameters in ref/relref (#995) ca06c9a56 Fix illegal character in render-link.html example 7a85c789b Update RenderString.md 69df3b17e Update configuration-markup.md 43e9222a2 Revert "Add shortcodes to note comparing with `markdownify`" 2bd5bc2d7 Add shortcodes to note comparing with `markdownify` ddfee60b7 Update configuration-markup.md f87c35fe2 docs: Remove extra double quotation 5ca5cc15f Update index.md 6e457f5ec Update configuration-markup.md 12df3c0fc Update configuration-markup.md 91977fd96 Update configuration-markup.md 377b8954a Update configuration-markup.md 99d691b5e Update hosting-on-render.md ccf855b22 Update index.md a945acc42 Update index.md 7d4f308d6 Fix Netlify config f4caa07f5 Release 0.62.0 79d18276f releaser: Add release notes to /docs for release of 0.62.0 9db1a08d1 Merge commit '8a4005cf2b0ef34265ff8051a6b76226685fc226' 79e556223 docs: More on hooks 5088c54df tpl: Do not return any value in errorf 98c8c8638 tpl: Add a warnf template func 4a9d76cea docs: Regen docshelper 626e53b55 Fix incorrect MIME type from image/jpg to image/jpeg f92f77c5d Preserve HTML Text for link render hooks 6db9c52b1 docs: Footnote 16801db3b Add render template hooks for links and images 0facb823c Merge commit '2e711a28c71e8667258e5ab824f9b9a71c261b0a' 79bf8ed4c markup/tableofcontents: Add config option for ordered list git-subtree-dir: docs git-subtree-split: bd0e15bb6063f7ad4f0c47eb33c8c0c23c962d13
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
---
|
||
title: .RenderString
|
||
description: "Renders markup to HTML."
|
||
godocref:
|
||
date: 2019-12-18
|
||
categories: [functions]
|
||
menu:
|
||
docs:
|
||
parent: "functions"
|
||
keywords: [markdown,goldmark,render]
|
||
signature: [".RenderString MARKUP"]
|
||
---
|
||
|
||
{{< new-in "0.62.0" >}}
|
||
|
||
`.RenderString` is a method on `Page` that renders some markup to HTML using the content renderer defined for that page (if not set in the options).
|
||
|
||
*Note* that this method does not parse and render shortcodes.
|
||
|
||
The method takes an optional map argument with these options:
|
||
|
||
display ("inline")
|
||
: `inline` or `block`. If `inline` (default), surrounding ´<p></p>` on short snippets will be trimmed.
|
||
|
||
markup (defaults to the Page's markup)
|
||
: See identifiers in [List of content formats](/content-management/formats/#list-of-content-formats).
|
||
|
||
Some examples:
|
||
|
||
```go-html-template
|
||
{{ $optBlock := dict "display" "block" }}
|
||
{{ $optOrg := dict "markup" "org" }}
|
||
{{ "**Bold Markdown**" | $p.RenderString }}
|
||
{{ "**Bold Block Markdown**" | $p.RenderString $optBlock }}
|
||
{{ "/italic org mode/" | $p.RenderString $optOrg }}:REND
|
||
```
|
||
|
||
|
||
**Note** that this method is more powerful than the similar [markdownify](/functions/markdownify/) function as it also supports [Render Hooks](/getting-started/configuration-markup/#markdown-render-hooks) and it has options to render other markup formats.
|