github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-02-09 00:42:17 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/functions/RenderString.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

Squashed 'docs/' changes from 54f0e8776..bd0e15bb6 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
2020-01-05 10:13:09 +00:00
---
title: .RenderString
description: "Renders markup to HTML."
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")
Squashed 'docs/' changes from ef9c4913c..d343ebf71 d343ebf71 Document ignoreImports f912ea1cc Fix the github workflow (#1332) 617894052 Add site function f3be651f9 Minor typo/markdown fixes (#1328) 7a95e9db5 Fix a formatting error for Github Actions (#1323) 260106669 Fix #1120 Use Github Action d8847a144 docs: Fix HTML code in .RenderString description being stripped out (#1320) 7a67c38c4 Correct sitemap version (#1318) 6a163f53a Removed noise. (#1317) b02902121 Fix a minor typo (#1314) 399c74acd Revert "js: Update shims setup" 77def8a8c Revert "Update js.md" 13aeb2c73 Update js.md 704987dc1 js: Update shims setup git-subtree-dir: docs git-subtree-split: d343ebf718393ea704da132de508db712f7bcb44
2021-02-18 16:52:49 +00:00
: `inline` or `block`. If `inline` (default), surrounding `<p></p>` on short snippets will be trimmed.
Squashed 'docs/' changes from 54f0e8776..bd0e15bb6 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
2020-01-05 10:13:09 +00:00
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 }}
Squashed 'docs/' changes from bd0e15bb6..16753a78d 16753a78d remove kaiju from comments.md 25906f6ad Hugo 0.64.0 aacc7a130 releaser: Add release notes to /docs for release of 0.64.0 2243afe90 Explain Ace/Amber support has been removed 293c9496a Document the hugo function 479890f9b Update comments.md ceab41097 Update theme 9a95876c7 Remove note 696543e13 Update usage.md a04bab2b9 Release 0.63.2 ccaed74b5 Merge branch 'temp632' 623b363c5 releaser: Add release notes to /docs for release of 0.63.2 39ce6f50e releaser: Add release notes to /docs for release of 0.63.2 9175ac2ca Another theme fix 88c264251 Rebuild _vendor e739dc3a8 Release 0.63.1 129ecac84 Merge branch 'temp631' bcd7c1154 releaser: Add release notes to /docs for release of 0.63.1 e4f0d9285 releaser: Add release notes to /docs for release of 0.63.1 6a40124d6 Update theme c486747de Params cleanup c408c4334 netlify: Bump to 0.63.0 7e8a48be8 Adjust base template docs a5920e9aa Adjust release notes d4d25c524 Merge branch 'temp63' 16d981721 releaser: Add release notes to /docs for release of 0.63.0 08ab681d1 releaser: Add release notes to /docs for release of 0.63.0 90feaac39 docs, output: Add base template lookup variant to docs.json afe2b4399 docs, output: Add base template lookup variant to docs.json 1f7466a76 docs: Regen docs helper 7ceefb94a docs: Regen docs helper ee14087cd Remove typo from RenderString.md 6daf333d3 Remove the calibreapp action 682f710d7 docs: Updating 'submodule add' command in "Host on GitHub" to use https instead of ssh. ef57b2dae Improve documentation on slug behavior 835ddd9c2 Fix broken link 137a32f90 Fixed typo in content-management/page-resources 936633e25 Fixed spelling error, "wich" -> "which" a559d41e3 Using a Different Version of Hugo in AWS Amplify 2ee83402d Update rss.md f900a2ce0 Add render-image code example and edit wording bd0a0207c Change wording on Page Resources documentation d213b4599 linuxbrew was renamed to homebrew (#1004) dcb0925f8 Update index.md 789416a08 Release 0.62.2 2dc66f13c releaser: Add release notes to /docs for release of 0.62.2 813fbc865 releaser: Add release notes to /docs for release of 0.62.2 ed5b07df3 docs: Document the new autoHeadingIDType setting 02d4747e5 docs: Document the new autoHeadingIDType setting 406a8a9a6 docs: Regenerate docshelper 065319786 docs: Regenerate docshelper 61d540021 Merge commit '26f1458a2df6b55eee3a5de46f5fec23a43a7c7d' 7cac5909b releaser: Add release notes to /docs for release of 0.62.1 6e30e01a2 releaser: Add release notes to /docs for release of 0.62.0 2694dcdd8 Merge commit '8a4005cf2b0ef34265ff8051a6b76226685fc226' 115dd6782 docs: More on hooks f4460fd54 tpl: Do not return any value in errorf 3587d2998 tpl: Add a warnf template func 7c9b02e30 docs: Regen docshelper a7bfdeb24 Fix incorrect MIME type from image/jpg to image/jpeg 1a6089cfe Preserve HTML Text for link render hooks 4544a998c docs: Footnote c42733258 Add render template hooks for links and images 0d8bec78a Merge commit '2e711a28c71e8667258e5ab824f9b9a71c261b0a' 3974c326c markup/tableofcontents: Add config option for ordered list 8c2bd1a62 releaser: Add release notes to /docs for release of 0.61.0 f00b2d507 releaser: Add release notes to /docs for release of 0.60.1 9a5109838 releaser: Add release notes to /docs for release of 0.60.0 d2c222f71 Add Goldmark as the new default markdown handler df96f9efa Update homepage.md f17e67b4b tpl/collections: Allow dict to create nested structures 5f923768a Merge commit 'efc0b1bb6c6564f54d596467dbc6a18cb206954e' 8a861bf16 Support Go time format strings in permalinks bbb8c4fea releaser: Add release notes to /docs for release of 0.59.1 9d9070dda releaser: Add release notes to /docs for release of 0.59.0 98716176b Merge commit '5ac0f751aa47e52625662215f66efa99a6abfc2e' 2057ba4c5 Merge commit '5070ba6c9e6c492deade3c30cfe769b9dbf7151d' c98bcff07 Merge commit 'b9bd35d72e14932fb6588ff62b90cddef0a060fc' as 'docs' git-subtree-dir: docs git-subtree-split: 16753a78d85e05c4a2cea94e263dda2e0047d155
2020-02-06 12:02:49 +00:00
{{ "/italic org mode/" | $p.RenderString $optOrg }}
Squashed 'docs/' changes from 54f0e8776..bd0e15bb6 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
2020-01-05 10:13:09 +00:00
```
**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.
Reference in a new issue Copy permalink