commit e6c27f76aa8a3f2b03f082c9c869e7a6269d6249
parent d376314763722f2523901fe23d9464ef069b892a
Author: philgs <phil.gs@gmail.com>
Date: Mon, 5 Jan 2015 06:15:49 -0500
Add example code to Summaries
I was initially confused about how to use summaries. The only example code I found in the docs was on the page for list nodes, but that uses `Render "summary"`, which is for views, not an article summary. I thought a little example here might clarify the issue for future users.
Diffstat:
1 file changed, 11 insertions(+), 0 deletions(-)
diff --git a/docs/content/content/summaries.md b/docs/content/content/summaries.md
@@ -29,3 +29,14 @@ If the summary content divider exists within a piece of content, Hugo will split
When using user-defined summaries, <code><!--more--></code>, Hugo will preserve the HTML in the summary.
The summary content divider only applies to the content that it appears in.
+
+## Showing Summaries
+
+You can show content summaries with the following code. You could do this, for example, on a [list](/templates/list/) node.
+
+ {{ range first 10 .Data.Pages }}
+ <div class="summary">
+ <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4>
+ {{ .Summary }}
+ </div>
+ {{ end }}