diff options
| author | Cameron Moore <moorereason@gmail.com> | 2020-10-21 04:07:11 +0300 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2020-10-21 10:49:25 +0300 |
| commit | 807db97af83ff61b022cbc8af80b9dc9cdb8dd43 (patch) | |
| tree | 3b633d6bdfaccf7fca9bd1ca28b7d31947d5703d /docs | |
| parent | 26eeb2914720929d2d778f14d6a4bf737014e9e3 (diff) | |
tpl: Refactor time.AsTime location implementation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/en/functions/time.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/content/en/functions/time.md b/docs/content/en/functions/time.md index 57d5f65f8..c4f74215b 100644 --- a/docs/content/en/functions/time.md +++ b/docs/content/en/functions/time.md @@ -13,13 +13,13 @@ menu: keywords: [dates,time,location] signature: ["time INPUT [LOCATION]"] workson: [] -hugoversion: +hugoversion: "v0.77.0" relatedfuncs: [] deprecated: false aliases: [] --- -`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` converts a timestamp string with an optional default location 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,9 +27,11 @@ aliases: [] {{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }} → 1464395400000, or Unix time in milliseconds ``` -## Using Timezone +## Using Locations -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]. +The optional `LOCATION` parameter is a string that sets a default location that is associated with the specified time value. If the time value has an explicit timezone or offset specified, it will take precedence over the `LOCATION` parameter. + +The list of valid locations may be system dependent, but should include `UTC`, `Local`, or any location in the [IANA Time Zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ``` {{ time "2020-10-20" }} → 2020-10-20 00:00:00 +0000 UTC @@ -37,8 +39,6 @@ The optional 2nd parameter [LOCATION] argument is a string that references a tim {{ 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. |