aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/page/RenderShortcodes.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/page/RenderShortcodes.md')
-rw-r--r--docs/content/en/methods/page/RenderShortcodes.md78
1 files changed, 0 insertions, 78 deletions
diff --git a/docs/content/en/methods/page/RenderShortcodes.md b/docs/content/en/methods/page/RenderShortcodes.md
deleted file mode 100644
index 4636bf8f5..000000000
--- a/docs/content/en/methods/page/RenderShortcodes.md
+++ /dev/null
@@ -1,78 +0,0 @@
----
-title: RenderShortcodes
-description: Renders all shortcodes in the content of the given page, preserving the surrounding markup.
-categories: []
-keywords: []
-action:
- related:
- - methods/page/RenderString
- - methods/page/Content
- - methods/page/RawContent
- - methods/page/Plain
- - methods/page/PlainWords
- returnType: template.HTML
- signatures: [PAGE.RenderShortcodes]
-toc: true
----
-
-{{< new-in 0.117.0 >}}
-
-Use this method in shortcode templates to compose a page from multiple content files, while preserving a global context for footnotes and the table of contents.
-
-For example:
-
-{{< code file=layouts/shortcodes/include.html >}}
-{{ $p := site.GetPage (.Get 0) }}
-{{ $p.RenderShortcodes }}
-{{< /code >}}
-
-Then in your markdown:
-
-{{< code file=content/about.md lang=md >}}
-{{%/* include "/snippets/services.md" */%}}
-{{%/* include "/snippets/values.md" */%}}
-{{%/* include "/snippets/leadership.md" */%}}
-{{< /code >}}
-
-Each of the included markdown files can contain calls to other shortcodes.
-
-## Shortcode notation
-
-In the example above it's important to understand the difference between the two delimiters used when calling a shortcode:
-
-- `{{</* myshortcode */>}}` tells Hugo that the rendered shortcode does not need further processing. For example, the shortcode content is HTML.
-- `{{%/* myshortcode */%}}` tells Hugo that the rendered shortcode needs further processing. For example, the shortcode content is markdown.
-
-Use the latter for the "include" shortcode described above.
-
-## Further explanation
-
-To understand what is returned by the `RenderShortcodes` method, consider this content file
-
-{{< code file=content/about.md lang=text >}}
-+++
-title = 'About'
-date = 2023-10-07T12:28:33-07:00
-+++
-
-{{</* ref "privacy" */>}}
-
-An *emphasized* word.
-{{< /code >}}
-
-With this template code:
-
-```go-html-template
-{{ $p := site.GetPage "/about" }}
-{{ $p.RenderShortcodes }}
-```
-
-Hugo renders this:;
-
-```html
-https://example.org/privacy/
-
-An *emphasized* word.
-```
-
-Note that the shortcode within the content file was rendered, but the surrounding markdown was preserved.