diff options
author | Bjørn Erik Pedersen <[email protected]> | 2024-09-04 18:52:05 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <[email protected]> | 2024-09-04 18:52:05 +0200 |
commit | 39fd3b557014e339bc6c68a7ff34a7734a735ee0 (patch) | |
tree | b73deb9fd547d283f2e5fb6a3b8393994c6c14f8 /content/en/methods | |
parent | dec8cd4ada29218971743333f8ac662a9c06aad8 (diff) | |
download | hugo-39fd3b557014e339bc6c68a7ff34a7734a735ee0.tar.gz hugo-39fd3b557014e339bc6c68a7ff34a7734a735ee0.zip |
Squashed 'docs/' changes from a49697e53..ccb1b97cb
ccb1b97cb Update blockquotes.md
a5f51431c Add new-in label
39dac5838 Document ContentWithoutSummary
de3c75694 Clarify blockquote render hook Markdown syntax
d32f7856d Document change to data type returned by render hook Text methods
83fe7ccc3 Document table render hooks
601234147 netlify: Hugo 0.134.0
a583640a0 Add support for Obsidian type blockquote alerts
3e0080861 Merge commit 'dec8cd4ada29218971743333f8ac662a9c06aad8'
2dde06576 output: Fix docshelper template lookup order for AMP pages
git-subtree-dir: docs
git-subtree-split: ccb1b97cbb11e60aab0108b33a270cccdd2218f6
Diffstat (limited to 'content/en/methods')
-rw-r--r-- | content/en/methods/page/Content.md | 6 | ||||
-rw-r--r-- | content/en/methods/page/ContentWithoutSummary.md | 28 | ||||
-rw-r--r-- | content/en/methods/page/Plain.md | 4 | ||||
-rw-r--r-- | content/en/methods/page/PlainWords.md | 3 | ||||
-rw-r--r-- | content/en/methods/page/RawContent.md | 2 | ||||
-rw-r--r-- | content/en/methods/page/RenderShortcodes.md | 4 |
6 files changed, 42 insertions, 5 deletions
diff --git a/content/en/methods/page/Content.md b/content/en/methods/page/Content.md index a9d38367c..373c6590a 100644 --- a/content/en/methods/page/Content.md +++ b/content/en/methods/page/Content.md @@ -5,6 +5,8 @@ categories: [] keywords: [] action: related: + - methods/page/Summary + - methods/page/ContentWithoutSummary - methods/page/RawContent - methods/page/Plain - methods/page/PlainWords @@ -13,9 +15,7 @@ action: signatures: [PAGE.Content] --- -The `Content` method on a `Page` object renders Markdown and shortcodes to HTML. The content does not include front matter. - -[shortcodes]: /getting-started/glossary/#shortcode +The `Content` method on a `Page` object renders Markdown and shortcodes to HTML. ```go-html-template {{ .Content }} diff --git a/content/en/methods/page/ContentWithoutSummary.md b/content/en/methods/page/ContentWithoutSummary.md new file mode 100644 index 000000000..5080f6717 --- /dev/null +++ b/content/en/methods/page/ContentWithoutSummary.md @@ -0,0 +1,28 @@ +--- +title: ContentWithoutSummary +description: Returns the rendered content of the given page, excluding the content summary. +categories: [] +keywords: [] +action: + related: + - methods/page/Content + - methods/page/Summary + - methods/page/RawContent + - methods/page/Plain + - methods/page/PlainWords + - methods/page/RenderShortcodes + returnType: template.HTML + signatures: [PAGE.ContentWithoutSummary] +--- + +{{< new-in 0.134.0 >}} + +Applicable when using manual or automatic [content summaries], the `ContentWithoutSummary` method on a `Page` object renders Markdown and shortcodes to HTML, excluding the content summary from the result. + +[content summaries]: /content-management/summaries/#manual-summary + +```go-html-template +{{ .ContentWithoutSummary }} +``` + +The `ContentWithoutSummary` method returns an empty string if you define the content summary in front matter. diff --git a/content/en/methods/page/Plain.md b/content/en/methods/page/Plain.md index 3aae1ed61..06d2bde48 100644 --- a/content/en/methods/page/Plain.md +++ b/content/en/methods/page/Plain.md @@ -6,6 +6,8 @@ keywords: [] action: related: - methods/page/Content + - methods/page/Summary + - methods/page/ContentWithoutSummary - methods/page/RawContent - methods/page/PlainWords - methods/page/RenderShortcodes @@ -13,7 +15,7 @@ action: signatures: [PAGE.Plain] --- -The `Plain` method on a `Page` object renders Markdown and [shortcodes] to HTML, then strips the HTML [tags]. It does not strip HTML [entities]. The plain content does not include front matter. +The `Plain` method on a `Page` object renders Markdown and [shortcodes] to HTML, then strips the HTML [tags]. It does not strip HTML [entities]. To prevent Go's [html/template] package from escaping HTML entities, pass the result through the [`htmlUnescape`] function. diff --git a/content/en/methods/page/PlainWords.md b/content/en/methods/page/PlainWords.md index 4f70193fe..221fd741b 100644 --- a/content/en/methods/page/PlainWords.md +++ b/content/en/methods/page/PlainWords.md @@ -6,8 +6,11 @@ keywords: [] action: related: - methods/page/Content + - methods/page/Summary + - methods/page/ContentWithoutSummary - methods/page/RawContent - methods/page/Plain + - methods/page/RenderShortcodes returnType: '[]string' signatures: [PAGE.PlainWords] --- diff --git a/content/en/methods/page/RawContent.md b/content/en/methods/page/RawContent.md index 12686c695..e4ab8a28e 100644 --- a/content/en/methods/page/RawContent.md +++ b/content/en/methods/page/RawContent.md @@ -6,6 +6,8 @@ keywords: [] action: related: - methods/page/Content + - methods/page/Summary + - methods/page/ContentWithoutSummary - methods/page/Plain - methods/page/PlainWords - methods/page/RenderShortcodes diff --git a/content/en/methods/page/RenderShortcodes.md b/content/en/methods/page/RenderShortcodes.md index a4120f69a..9679fc8d5 100644 --- a/content/en/methods/page/RenderShortcodes.md +++ b/content/en/methods/page/RenderShortcodes.md @@ -5,11 +5,13 @@ categories: [] keywords: [] action: related: - - methods/page/RenderString - methods/page/Content + - methods/page/Summary + - methods/page/ContentWithoutSummary - methods/page/RawContent - methods/page/Plain - methods/page/PlainWords + - methods/page/RenderString returnType: template.HTML signatures: [PAGE.RenderShortcodes] toc: true |