From 1d4dde7ac3842796916277d579b2627d93a624ec Mon Sep 17 00:00:00 2001
From: Will Stevens <wstevens@cloudops.com>
Date: Wed, 8 Oct 2014 12:05:22 -0400
Subject: [PATCH] added docs for 'intersect' and 'in' template functions
---
docs/content/templates/functions.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md
index 9da9476a..4d4d9332 100644
--- a/docs/content/templates/functions.md
+++ b/docs/content/templates/functions.md
@@ -72,6 +72,32 @@ e.g.
{{ .Content}}
{{ end }}
+### in
+Checks if an element is in an array (or slice) and returns a boolean. The elements supported are strings, integers and floats (only float64 will match as expected). In addition, it can also check if a substring exists in a string.
+
+e.g.
+ {{ if in .Params.tags "Git" }}Follow me on GitHub!{{ end }}
+or
+ {{ if in "this string contains a substring" "substring" }}Substring found!{{ end }}
+
+### intersect
+Given two arrays (or slices), this function will return the common elements in the arrays. The elements supported are strings, integers and floats (only float64).
+
+A useful example of this functionality is a 'similar posts' block. Create a list of links to posts where any of the tags in the current post match any tags in other posts.
+
+e.g.
+ <ul>
+ {{ $page_link := .Permalink }}
+ {{ $tags := .Params.tags }}
+ {{ range .Site.Recent }}
+ {{ $page := . }}
+ {{ $has_common_tags := intersect $tags .Params.tags | len | lt 0 }}
+ {{ if and $has_common_tags (ne $page_link $page.Permalink) }}
+ <li><a href="{{ $page.Permalink }}">{{ $page.Title }}</a></li>
+ {{ end }}
+ {{ end }}
+ </ul>
+
## Math
--
2.30.2