diff options
| author | Mark Johnson <739719+virgofx@users.noreply.github.com> | 2020-10-19 15:58:05 -0700 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2020-10-21 09:49:25 +0200 |
| commit | 26eeb2914720929d2d778f14d6a4bf737014e9e3 (patch) | |
| tree | 04dbbfcd3b347ff4ba24dda205c72e3a5d775811 /docs | |
| parent | b886fa46bb92916152476cfac45c7a5ee5e5820a (diff) | |
tpl: Update Hugo time to support optional [LOCATION] parameter
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/en/functions/time.md | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/content/en/functions/time.md b/docs/content/en/functions/time.md index 3be2d4368..57d5f65f8 100644 --- a/docs/content/en/functions/time.md +++ b/docs/content/en/functions/time.md @@ -10,8 +10,8 @@ categories: [functions] menu: docs: parent: "functions" -keywords: [dates,time] -signature: ["time INPUT"] +keywords: [dates,time,location] +signature: ["time INPUT [LOCATION]"] workson: [] hugoversion: relatedfuncs: [] @@ -19,7 +19,7 @@ deprecated: false aliases: [] --- -`time` converts a timestamp string into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields: +`time` converts a timestamp string with an optional timezone into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields: ``` {{ time "2016-05-28" }} → "2016-05-28T00:00:00Z" @@ -27,6 +27,18 @@ aliases: [] {{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }} → 1464395400000, or Unix time in milliseconds ``` +## Using Timezone + +The optional 2nd parameter [LOCATION] argument is a string that references a timezone that is associated with the specified time value. If the time value has an explicit timezone or offset specified, it will take precedence over an explicit [LOCATION]. + +``` +{{ time "2020-10-20" }} → 2020-10-20 00:00:00 +0000 UTC +{{ time "2020-10-20" "America/Los_Angeles" }} → 2020-10-20 00:00:00 -0700 PDT +{{ time "2020-01-20" "America/Los_Angeles" }} → 2020-01-20 00:00:00 -0800 PST +``` + +> **Note**: Timezone support via the [LOCATION] parameter is included with Hugo `0.77`. + ## Example: Using `time` to get Month Index The following example takes a UNIX timestamp---set as `utimestamp: "1489276800"` in a content's front matter---converts the timestamp (string) to an integer using the [`int` function][int], and then uses [`printf`][] to convert the `Month` property of `time` into an index. |