--- title: Inner description: Returns the content between opening and closing shortcode tags, applicable when the shortcode call includes a closing tag. categories: [] keywords: [] action: related: - functions/strings/Trim - methods/page/RenderString - functions/transform/Markdownify - methods/shortcode/InnerDeindent returnType: template.HTML signatures: [SHORTCODE.Inner] --- This content: {{< code file=content/services.md lang=md >}} {{}} We design the **best** widgets in the world. {{}} {{< /code >}} With this shortcode: {{< code file=layouts/shortcodes/card.html >}}
{{ with .Get "title" }}
{{ . }}
{{ end }}
{{ trim .Inner "\r\n" }}
{{< /code >}} Is rendered to: ```html
Product Design
We design the **best** widgets in the world.
``` {{% note %}} Content between opening and closing shortcode tags may include leading and/or trailing newlines, depending on placement within the Markdown. Use the [`trim`] function as shown above to remove both carriage returns and newlines. [`trim`]: /functions/strings/trim/ {{% /note %}} {{% note %}} In the example above, the value returned by `Inner` is Markdown, but it was rendered as plain text. Use either of the following approaches to render Markdown to HTML. {{% /note %}} ## Use the RenderString method Let's modify the example above to pass the value returned by `Inner` through the [`RenderString`] method on the `Page` object: [`RenderString`]: /methods/page/renderstring/ {{< code file=layouts/shortcodes/card.html >}}
{{ with .Get "title" }}
{{ . }}
{{ end }}
{{ trim .Inner "\r\n" | .Page.RenderString }}
{{< /code >}} Hugo renders this to: ```html
Product design
We produce the best widgets in the world.
``` You can use the [`markdownify`] function instead of the `RenderString` method, but the latter is more flexible. See [details]. [details]: /methods/page/renderstring/ [`markdownify`]: /functions/transform/markdownify/ ## Use alternate notation Instead of calling the shortcode with the `{{}}` notation, use the `{{%/* */%}}` notation: {{< code file=content/services.md lang=md >}} {{%/* card title="Product Design" */%}} We design the **best** widgets in the world. {{%/* /card */%}} {{< /code >}} When you use the `{{%/* */%}}` notation, Hugo renders the entire shortcode as Markdown, requiring the following changes. First, configure the renderer to allow raw HTML within Markdown: {{< code-toggle file=hugo >}} [markup.goldmark.renderer] unsafe = true {{< /code-toggle >}} This configuration is not unsafe if _you_ control the content. Read more about Hugo's [security model]. Second, because we are rendering the entire shortcode as Markdown, we must adhere to the rules governing [indentation] and inclusion of [raw HTML blocks] as provided in the [CommonMark] specification. {{< code file=layouts/shortcodes/card.html >}}
{{ with .Get "title" }}
{{ . }}
{{ end }}
{{ trim .Inner "\r\n" }}
{{< /code >}} The difference between this and the previous example is subtle but required. Note the change in indentation, the addition of a blank line, and removal of the `RenderString` method. ```diff --- layouts/shortcodes/a.html +++ layouts/shortcodes/b.html @@ -1,8 +1,9 @@
{{ with .Get "title" }} -
{{ . }}
+
{{ . }}
{{ end }}
- {{ trim .Inner "\r\n" | .Page.RenderString }} + + {{ trim .Inner "\r\n" }}
``` {{% note %}} When using the `{{%/* */%}}` notation, do not pass the value returned by `Inner` through the `RenderString` method or the `markdownify` function. {{% /note %}} [commonmark]: https://commonmark.org/ [indentation]: https://spec.commonmark.org/0.30/#indented-code-blocks [raw html blocks]: https://spec.commonmark.org/0.30/#html-blocks [security model]: /about/security/