blogs/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2026-09-02 03:32:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make default "related" behavior more explicit

Browse Source 
Added a link to the package documentation provided by @bep and a few sentences describing how to use the default indices (keywords and date) and pointing out the default behaviour for includeNewer. Might be better to put this up above but I've included it in the "List related content" section where, I think, most people will start. Hopefully others will improve on what I've done... thanks!
This commit is contained in:
Peter Kappus
2018-08-19 13:16:04 -04:00
committed by Bjørn Erik Pedersen
parent 60b9160eb4
commit d881d14339
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/content-management/related.md
+6 -1
View File
@@ -14,13 +14,18 @@ aliases: [/content/related/,/related/]
toc: true
---
{{% note %}}
We currently do not index **Page content**. We thought we would release something that will make most people happy before we start solving [Sherlock's last case](https://github.com/joearms/sherlock).
{{% /note %}}
## List Related Content
To list up to 5 related pages is as simple as including something similar to this partial in your single page template:
Hugo uses "indices" based on front matter parameters to identify related content. By default, it creates indices for the "**keywords**" and "**date**" parameters but you can create an index for any parameters you like (see below). Read the ["related" package documentation](https://godoc.org/github.com/gohugoio/hugo/related#pkg-variables) for more. The default behavior is to **exclude** related posts which are _newer_ than the current post. This can be configured via _includeNewer_ in your site-wide `config.toml` (see below).
To use the default Related Content behaviour, please make sure these parameters are included (and match one another) in the front matter of your related posts e.g. include `keywords: [music]` to relate music posts.
To list up to 5 related pages (which share the same _date_ or _keyword_ parameters) is as simple as including something similar to this partial in your single page template:
{{< code file="layouts/partials/related.html" >}}
{{ $related := .Site.RegularPages.Related . | first 5 }}