diff options
Diffstat (limited to 'docs/content/en/functions')
| -rw-r--r-- | docs/content/en/functions/GetPage.md | 2 | ||||
| -rw-r--r-- | docs/content/en/functions/default.md | 2 | ||||
| -rw-r--r-- | docs/content/en/functions/intersect.md | 22 | ||||
| -rw-r--r-- | docs/content/en/functions/os.Stat.md | 33 |
4 files changed, 36 insertions, 23 deletions
diff --git a/docs/content/en/functions/GetPage.md b/docs/content/en/functions/GetPage.md index 2d9de4d7a..366d1f093 100644 --- a/docs/content/en/functions/GetPage.md +++ b/docs/content/en/functions/GetPage.md @@ -31,7 +31,7 @@ aliases: [] This method wil return `nil` when no page could be found, so the above will not print anything if the blog section is not found. -To fund a regular page in the blog section:: +To find a regular page in the blog section:: ```go-html-template {{ with .Site.GetPage "/blog/my-post.md" }}{{ .Title }}{{ end }} diff --git a/docs/content/en/functions/default.md b/docs/content/en/functions/default.md index 1b5a9fb6f..18f7b7d33 100644 --- a/docs/content/en/functions/default.md +++ b/docs/content/en/functions/default.md @@ -22,7 +22,7 @@ aliases: [] needsexamples: false --- -`default` checks whether a given value is set and returns a default value if it is not. *Set* in this context means different things depending on date type: +`default` checks whether a given value is set and returns a default value if it is not. *Set* in this context means different things depending on the data type: * non-zero for numeric types and times * non-zero length for strings, arrays, slices, and maps diff --git a/docs/content/en/functions/intersect.md b/docs/content/en/functions/intersect.md index a607ff217..6d2efacbc 100644 --- a/docs/content/en/functions/intersect.md +++ b/docs/content/en/functions/intersect.md @@ -19,27 +19,7 @@ deprecated: false aliases: [] --- -The elements supported are strings, integers, and floats (only float64). - -A useful example of `intersect` functionality is a "related posts" block. `isset` allows us to create a list of links to other posts that have tags that intersect with the tags in the current post. - -The following is an example of a "related posts" [partial template][partials] that could be added to a [single page template][single]: - -{{< code file="layouts/partials/related-posts.html" download="related-posts.html" >}} -<ul> -{{ $page_link := .Permalink }} -{{ $tags := .Params.tags }} -{{ range .Site.Pages }} - {{ $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> -{{< /code >}} - -This is also very useful to use as `AND` filters when combined with where: +An useful example is to use it as `AND` filters when combined with where: ``` {{ $pages := where .Site.RegularPages "Type" "not in" (slice "page" "about") }} diff --git a/docs/content/en/functions/os.Stat.md b/docs/content/en/functions/os.Stat.md new file mode 100644 index 000000000..1e878d896 --- /dev/null +++ b/docs/content/en/functions/os.Stat.md @@ -0,0 +1,33 @@ +--- +title: os.Stat +description: Gets a file information of a given path. +godocref: +date: 2018-08-07 +publishdate: 2018-08-07 +lastmod: 2018-08-07 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [files] +signature: ["os.Stat PATH"] +workson: [] +hugoversion: +relatedfuncs: [readDir] +deprecated: false +aliases: [] +--- + +If your current project working directory has a single file named `README.txt` (30 bytes): +``` +{{ $stat := os.Stat "README.txt" }} +{{ $stat.Name }} → "README.txt" +{{ $stat.Size }} → 30 +``` + +Function [`os.Stat`][Stat] returns [`os.FileInfo`][osfileinfo]. +For further information of `os.FileInfo`, see [golang page][osfileinfo]. + + +[Stat]: /functions/os.Stat/ +[osfileinfo]: https://golang.org/pkg/os/#FileInfo |