From 9e029fe41204e2c06dc867b1cf8ab97e8c100397 Mon Sep 17 00:00:00 2001 From: Joel Scoble Date: Wed, 15 Oct 2014 17:59:43 -0500 Subject: [PATCH] #463 add summary.md page --- docs/content/content/example.md | 2 +- docs/content/content/ordering.md | 2 +- docs/content/content/summaries.md | 25 +++++++++++++++++++++++++ 3 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 docs/content/content/summaries.md diff --git a/docs/content/content/example.md b/docs/content/content/example.md index ff008308a..17de00fd0 100644 --- a/docs/content/content/example.md +++ b/docs/content/content/example.md @@ -8,7 +8,7 @@ menu: parent: content next: /themes/overview notoc: true -prev: /content/ordering +prev: /content/summaries title: Example Content File weight: 70 --- diff --git a/docs/content/content/ordering.md b/docs/content/content/ordering.md index 5190d777b..910aba74d 100644 --- a/docs/content/content/ordering.md +++ b/docs/content/content/ordering.md @@ -4,7 +4,7 @@ linktitle: Ordering menu: main: parent: content -next: /content/example +next: /content/summaries prev: /content/archetypes title: Ordering Content weight: 60 diff --git a/docs/content/content/summaries.md b/docs/content/content/summaries.md new file mode 100644 index 000000000..266529c08 --- /dev/null +++ b/docs/content/content/summaries.md @@ -0,0 +1,25 @@ +--- +date: 2013-07-01 +menu: + main: + parent: content +next: /content/example +notoc: true +prev: /content/ordering +title: Summaries +weight: 65 +--- + +Hugo generates summaries of content for easily showing snippets in summary views. The summary view snippets are automatically generated by Hugo. Where a piece of content's summary is split depends on whether the split is Hugo defined or use defined. + +Content summaries provide links to the original content, usually in the form of a `Read More` link. + +## Automatic summary split + +By default, Hugo automatically splits content after 70 words, with the content prior to the split being used for the content summary. This way you don't have to worry about content summary unless you want to customize it; the summary is automatically created for you, and available to be used by Hugo, without any additional work on your part. + +## User defined summary split + +Hugo also provides an easy way to customize a piece of content's split with its summary content divider: <!--more-->. If the summary content divider exists within a piece of content, Hugo will split the content at that point, instead of the default 70 words. The content prior to the summary content provider will be used as that content's summary. The summary content provider, <!--more-->, will be elided from the rendered content. + +The summary content divider only applies to the content that it appears in.