From 000cf85f497802aaf16a61e922d5b082612ddf8f Mon Sep 17 00:00:00 2001 From: Kaushal Modi Date: Thu, 23 Aug 2018 15:19:48 -0400 Subject: [PATCH] Make the pros/cons styling consistent for summaries; use desc list --- content/en/content-management/summaries.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/content/en/content-management/summaries.md b/content/en/content-management/summaries.md index 0f8939377..bf2f0fec8 100644 --- a/content/en/content-management/summaries.md +++ b/content/en/content-management/summaries.md @@ -30,8 +30,11 @@ It is natural to accompany the summary with links to the original content, and a 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. Taking the Hugo-defined approach to summaries may save time, but it has pros and cons: -* **Pros:** Automatic, no additional work on your part. -* **Cons:** All HTML tags are stripped from the summary, and the first 70 words, whether they belong to a heading or to different paragraphs, are all put into one paragraph. +Pros +: Automatic, no additional work on your part. + +Cons +: All HTML tags are stripped from the summary, and the first 70 words, whether they belong to a heading or to different paragraphs, are all put into one paragraph. {{% note %}} The Hugo-defined summaries are set to use word count calculated by splitting the text by one or more consecutive white space characters. If you are creating content in a `CJK` language and want to use Hugo's automatic summary splitting, set `hasCJKLanguage` to `true` in you [site configuration](/getting-started/configuration/). @@ -45,8 +48,11 @@ Alternatively, you may add the <!--more--><!--more--> (or `# more` for [org content][org]) in each content file. This can be automated by adding the summary divider below the front matter of an [archetype](/content-management/archetypes/). +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][org]) in each content file. This can be automated by adding the summary divider below the front matter of an [archetype](/content-management/archetypes/). {{% warning "Be Precise with the Summary Divider" %}} Be careful to enter <!--more--> exactly; i.e., all lowercase and with no whitespace.