346b60358d
73a01565c Remove comment shortcode documentation 0ca7ccd30 Replace usage of comment shortcode with HTML comments fe10d9899 Remove expired new-in labels 11e89dfcb [editorial] Link to proper render-hook page in relref.md 11a581c2f netlify: Hugo 0.142.0 1a4fcf7f7 Miscellaneous edits 2c7a3165f Markdown linting and cleanup 69d7a781b Replace links to glossary terms with custom render hook syntax 441752d2d Refactor glossary lookup portion of link render hook 80109a14f Fix glossary term linking for plural form cd95f0f34 Update link render hook to support glossary links 53eadb430 Remove the glossary template 1d40a7f3b Improve transform.ToMath examples 586970df2 Misc edits 6a06a8de7 Add glossary link shortcode 4171c0eb7 Improve description of masking with non-transparent images 41c8feb64 Fix example of image.Mask filter 704a81656 Add alignx option to images.Text usage example 7c03eb0cc Clarify context in example of using the try statement 56d9c9b71 Refactor glossary of terms 042a6846b Add expiry dates to deprecated methods pages 365ab345f Remove services key from instagram shortcode page b7fe31e07 Reorder options list for images.Text filter 8051ff818 Format directory names, file names, and file paths as code d09a14623 Update version refs for Hugo and Dart Sass 3bb006974 Add NODE_VERSION to Netlify config examples 3a0f2531e Fix typo 7e3198eaf Fix typo cf56452a3 Fix typo a9f51d13e Fix typo 82bfdd8c3 Fix typo a5c41a053 Fix typo abcfed7a5 Fix typo 8c1debf3a Remove outdated new-in badges 809ddf9ef Update theme 63867d56f Use warnf instead of errorf in try-catch example dee3e5f09 Update theme 9791f7057 Remove TODO from comment shortcode examples a346ca1fd Elevate embedded shortcode documentation to its own section 8fa19b50f hugoreleaser.toml => hugoreleaser.yaml 575d60345 Update docs for v0.141.0 a0a442d62 netlify: Hugo 0.141.0 6667cbcd8 Merge commit '81a7b6390036138356773c87a886679c81c524e1' f36fc013e docs: Regen CLI docs 365a47ded tpl/images: Change signature of images.QR to images.QR TEXT OPTIONS ae8f8af0a images.Text: Add "alignx" option for horizontal alignment 8f45ccca6 docs: Regen CLI docs f0e6304f4 Merge commit 'e9fbadacc3f09191e2e19f112a49777eeb8df06c' cb9bec2b2 tpl/images: Add images.QR function git-subtree-dir: docs git-subtree-split: 73a01565c5ba0774d65aa6f2384c44804fefa37d
129 lines
3.3 KiB
Markdown
129 lines
3.3 KiB
Markdown
---
|
|
title: Content summaries
|
|
linkTitle: Summaries
|
|
description: Create and render content summaries.
|
|
categories: [content management]
|
|
keywords: [summaries,abstracts,read more]
|
|
menu:
|
|
docs:
|
|
parent: content-management
|
|
weight: 160
|
|
weight: 160
|
|
toc: true
|
|
aliases: [/content/summaries/,/content-management/content-summaries/]
|
|
---
|
|
|
|
<!-- Do not remove the manual summary divider below. -->
|
|
<!-- If you do, you will break its first literal usage on this page. -->
|
|
|
|
<!--more-->
|
|
|
|
You can define a summary manually, in front matter, or automatically. A manual summary takes precedence over a front matter summary, and a front matter summary takes precedence over an automatic summary.
|
|
|
|
Review the [comparison table](#comparison) below to understand the characteristics of each summary type.
|
|
|
|
## Manual summary
|
|
|
|
Use a `<!--more-->` divider to indicate the end of the summary. Hugo will not render the summary divider itself.
|
|
|
|
{{< code file=content/example.md >}}
|
|
+++
|
|
title: 'Example'
|
|
date: 2024-05-26T09:10:33-07:00
|
|
+++
|
|
|
|
This is the first paragraph.
|
|
|
|
<!--more-->
|
|
|
|
This is the second paragraph.
|
|
{{< /code >}}
|
|
|
|
When using the Emacs Org Mode [content format], use a `# more` divider to indicate the end of the summary.
|
|
|
|
[content format]: /content-management/formats/
|
|
|
|
## Front matter summary
|
|
|
|
Use front matter to define a summary independent of content.
|
|
|
|
{{< code file=content/example.md >}}
|
|
+++
|
|
title: 'Example'
|
|
date: 2024-05-26T09:10:33-07:00
|
|
summary: 'This summary is independent of the content.'
|
|
+++
|
|
|
|
This is the first paragraph.
|
|
|
|
This is the second paragraph.
|
|
{{< /code >}}
|
|
|
|
## Automatic summary
|
|
|
|
If you do not define the summary manually or in front matter, Hugo automatically defines the summary based on the [`summaryLength`] in your site configuration.
|
|
|
|
[`summaryLength`]: /getting-started/configuration/#summarylength
|
|
|
|
{{< code file=content/example.md >}}
|
|
+++
|
|
title: 'Example'
|
|
date: 2024-05-26T09:10:33-07:00
|
|
+++
|
|
|
|
This is the first paragraph.
|
|
|
|
This is the second paragraph.
|
|
|
|
This is the third paragraph.
|
|
{{< /code >}}
|
|
|
|
For example, with a `summaryLength` of 7, the automatic summary will be:
|
|
|
|
```html
|
|
<p>This is the first paragraph.</p>
|
|
<p>This is the second paragraph.</p>
|
|
```
|
|
|
|
## Comparison
|
|
|
|
Each summary type has different characteristics:
|
|
|
|
Type|Precedence|Renders markdown|Renders shortcodes|Wraps single lines with `<p>`
|
|
:--|:-:|:-:|:-:|:-:
|
|
Manual|1|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
|
Front matter|2|:heavy_check_mark:|:x:|:x:
|
|
Automatic|3|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
|
|
|
## Rendering
|
|
|
|
Render the summary in a template by calling the [`Summary`] method on a `Page` object.
|
|
|
|
[`Summary`]: /methods/page/summary
|
|
|
|
```go-html-template
|
|
{{ range site.RegularPages }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
<div class="summary">
|
|
{{ .Summary }}
|
|
{{ if .Truncated }}
|
|
<a href="{{ .RelPermalink }}">More ...</a>
|
|
{{ end }}
|
|
</div>
|
|
{{ end }}
|
|
```
|
|
|
|
## Alternative
|
|
|
|
Instead of calling the `Summary` method on a `Page` object, use the [`strings.Truncate`] function for granular control of the summary length. For example:
|
|
|
|
[`strings.Truncate`]: /functions/strings/truncate/
|
|
|
|
```go-html-template
|
|
{{ range site.RegularPages }}
|
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
|
<div class="summary">
|
|
{{ .Content | strings.Truncate 42 }}
|
|
</div>
|
|
{{ end }}
|
|
```
|