![Bjørn Erik Pedersen](/assets/img/avatar_default.png)
4dd2d6415 Fix erroridf example 9ae8e9199 Clarify highlight options f3943f9c8 Fix typo b57ea5ac8 Add field to glossary of terms 3191e35b4 Clarify comment in the new-in shortcode 870c8d35c Correct description of Ref and RelRef page methods c9df50e6e Specify encoding in description of crypto functions 749bb37e2 Add Ref, RelRef, and Site shortcode methods 994d4374b Update fmt functions 740f5ef96 Misc additions 77acdcdb6 Remove rssLimit from root config documentation df84a1795 Document the openapi3.Unmarshal function 24236f57d Miscellaneous edits and corrections 41b54d421 Hide the "new in" button after some period of time 3c1ebac31 Update Ancestors.md e699eb313 Add new-in tags to select functions and methods 5c41f0bf8 Clarify time.Format method f7bd43ae1 Add link to built-in render hook for GoAT diagrams 06f9cd4c9 Document the diagrams.Goat function 5e432e12d Adjust quick reference weights fc915efd6 Update FAQ 5bccf8b19 Use LinkTitle consistently in examples 36f207f3a Add page collection quick reference 699de883d Inlcude example of newScratch.Values 9bb7f8c78 Include RenderString example for emoji shortcodes 783fdd3ac Fix typo 26d5a4399 Fix typo c7e86f0cf Fix typo ad2a82fbd Clarify data type returned by partial and partialCached 1de5a52dd Miscellaneous corrections 3509e1b4d Update configuration-markup.md 8c6a9bf02 Clairfy figure shortcode output c9d0dc8fb Update Markdownify.md 0c4bc1447 Update theme 0f0ab2ade Add methods deprecated in v0.120.0 e1c6ecd0f Miscellaneous edits ec53b55b9 netlify: Hugo 0.120.4 23a1f3fd5 templates/internal.md: Correct GoogleAnalytics key name 6dcfa9a82 Update troubleshooting section 0c8857e8f Adjust code and code-toggle shortcodes 8820264d3 Reduce number of site audit warnings 526d06b90 Clarify hint option in image processing spec 310849daa Image Processing: Improve sentence and fix code sample 5bb67bfd4 Revert "Image Processing: Improve sentence and fix code sample" (#2318) 77c926fde Image Processing: Improve sentence and fix code sample 52179fb18 Miscellaneous edits f4e886715 Revert change to hugo.work c410fefa8 Update theme 8b72dfedd Rework where function documentation f35a7126f Minor edits to global page function 903b42ebc Cleanup shortcode calls c9247e98d Update documentation.md dff3c4abb Clean up build option descriptions and examples f46d31308 Use consistent signatures 2af2470b5 Minor correction to resources.GetRemote 45ec53fe0 Remove superfluous shortcode param 2a0544757 Improve deployment documentation 3cf36a7fc Clarify lang keyword f10d6495d Update front-matter.md dc94e20be Add Sveltia to CMS list b15d6d670 Update front-ends.md bb41588b2 Update FormatCurrency.md b40fff396 Add showcase for hidden sections without index.html 71316e181 Improve image filter examples d46f0b1d8 Miscellaneous edits ad3f9cdb6 Adjust quick reference guides 8657804ba Update theme d9e981147 Miscellaneous corrections 508666575 Miscellaneous updates 80b2241f9 Miscellaneous updates 723a827fd Namespace functions and methods 40212779a netlify: Hugo 0.120.3 66017c704 Bump GitHub workflows to latest versions db0f1e682 Update related.md 7e758c23b netlify: Hugo 0.120.2 641ba3976 Update configuration.md d2a9909d9 Update rss.md 7eb59d7a2 netlify: Hugo 0.120.1 708c351c4 Document debug.Timer 28e2388c2 Add new-in tag to images.Padding ee24cffb5 Add new-in tags to hugo.IsDevelopment and hugo.IsServer aa47ca023 netlify: Hugo 0.120.0 9c3e606fc docs: Regen docshelper 159fd971e commands/new: Remove format flag from new content cmd 9f7878092 Merge commit 'aaaf1c8df5d6aa061609d20510f7fa6c42e5cc1a' 65b2dd324 docs: Regenerate docshelper 2be620663 resources/images: Create padding image filter c777d6c5e Merge commit '3710a5ec7efe6baca6e452f43632c05d22bab3c4' 24f2afeb2 Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688' 3f947c19a hugolib: Deprecate .Site.DisqusShortname 6bd1af892 hugolib: Deprecate .Site.GoogleAnalytics 78becc6ee tpl/tplimpl: Deprecate .Site.Social usage with internal templates e3ec2a4f2 common/hugo: Add hugo.IsServer and hugo.IsDevelopment git-subtree-dir: docs git-subtree-split: 4dd2d641531f74025ed9f51ea5a961e936988cfb
4.9 KiB
title | linkTitle | description | categories | keywords | menu | weight | toc | aliases | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Content summaries | Summaries | Hugo generates summaries of your content. |
|
|
|
160 | true |
|
With the use of the .Summary
page variable, Hugo generates summaries of content to use as a short version in summary views.
Summary splitting options
- Automatic Summary Split
- Manual Summary Split
- Front Matter Summary
It is natural to accompany the summary with links to the original content, and a common design pattern is to see this link in the form of a "Read More ..." button. See the .RelPermalink
, .Permalink
, and .Truncated
page variables.
Automatic summary splitting
By default, Hugo automatically takes the first 70 words of your content as its summary and stores it into the .Summary
page variable for use in your templates. You may customize the summary length by setting summaryLength
in your site configuration.
{{% note %}}
You can customize how HTML tags in the summary are loaded using functions such as plainify
and safeHTML
.
{{% /note %}}
{{% note %}}
The Hugo-defined summaries are set to use word count calculated by splitting the text by one or more consecutive whitespace characters. If you are creating content in a CJK
language and want to use Hugo's automatic summary splitting, set hasCJKLanguage
to true
in your site configuration.
{{% /note %}}
Manual summary splitting
Alternatively, you may add the <!--more-->
summary divider where you want to split the article.
For Org mode content, use # more
where you want to split the article.
Content that comes before the summary divider will be used as that content's summary and stored in the .Summary
page variable with all HTML formatting intact.
{{% note %}} The concept of a summary divider is not unique to Hugo. It is also called the "more tag" or "excerpt separator" in other literature. {{% /note %}}
- Pros
- Freedom, precision, and improved rendering. All HTML tags and formatting are preserved.
- Cons
- Extra work for content authors, since they need to remember to type
<!--more-->
(or# more
for org content) in each content file. This can be automated by adding the summary divider below the front matter of an archetype.
{{% note %}}
Be careful to enter <!--more-->
exactly; i.e., all lowercase and with no whitespace.
{{% /note %}}
Front matter summary
You might want your summary to be something other than the text that starts the article. In this case you can provide a separate summary in the summary
variable of the article front matter.
- Pros
- Complete freedom of text independent of the content of the article. Markup can be used within the summary.
- Cons
- Extra work for content authors as they need to write an entirely separate piece of text as the summary of the article.
Summary selection order
Because there are multiple ways in which a summary can be specified it is useful to understand the order of selection Hugo follows when deciding on the text to be returned by .Summary
. It is as follows:
- If there is a
<!--more-->
> summary divider present in the article the text up to the divider will be provided as per the manual summary split method - If there is a
summary
variable in the article front matter the value of the variable will be provided as per the front matter summary method - The text at the start of the article will be provided as per the automatic summary split method
{{% note %}}
Hugo uses the first of the above steps that returns text. So if, for example, your article has both summary
variable in its front matter and a <!--more-->
summary divider Hugo will use the manual summary split method.
{{% /note %}}
Example: first 10 articles with summaries
You can show content summaries with the following code. You could use the following snippet, for example, in a section template.
{{< code file=page-list-with-summaries.html >}} {{ range first 10 .Pages }}
{{ .Title }}
{{ .Summary }}Note how the .Truncated
boolean variable value may be used to hide the "Read More..." link when the content is not truncated; i.e., when the summary contains the entire article.