2c0d1ccdcd
73f355ce Update theme 83ff50c2 Use example.com in examples 71292134 Add alias news > release-notes 2e15f642 Update theme 8eef09d2 Add Pygments configuration 572b9e75 Clean up the code shortcode use a1b2fd3b Remove the code fence language codes 1473b1d9 Remove redundant text b92c2042 Update theme 8f439c28 Edit contributing section in README 8bcf8a19 Add contributing section to README 4c44ee1c Fix broken content file 2bdc7710 Clarify .Data.Pages sorting in lists.md 092271c2 Use infinitive mood for main titles b9b8abef Update theme to reflect change to home page content b897b71b Change copy to use sentence case fd675ee5 Enable RSS feed for sections 060a5e27 Correct movie title in taxonomies.md 6a5ca96a Update displayed site name for Hub 22f4b7a4 Add example of starting up the local server d9612cb3 Update theme a8c3988a Update theme 4198189d Update theme 12d6b016 Update theme 2b1c4197 Update theme b6d90a1e Fix News release titles cfe751db Add some build info to README git-subtree-dir: docs git-subtree-split: 73f355ce0dd88d032062ea70067431ab980cdd8d
3.5 KiB
| title | description | godocref | date | publishdate | lastmod | categories | menu | signature | workson | hugoversion | relatedfuncs | deprecated | aliases | toc | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| .Format | Formats built-in Hugo dates---`.Date`, `.PublishDate`, and `.LastMod`---according to Go's layout string. | https://golang.org/pkg/time/#example_Time_Format | 2017-02-01 | 2017-02-01 | 2017-02-01 |
|
|
|
|
|
false | true |
.Format will format date values defined in your front matter and can be used as a property on the following page variables:
.PublishDate.Date.LastMod
Assuming a key-value of date: 2017-03-03 in a content file's front matter, your can run the date through .Format followed by a layout string for your desired output at build time:
{{ .PublishDate.Format "January 2, 2006" }} => March 3, 2017
For formatting any string representations of dates defined in your front matter, see the dateFormat function, which will still leverage the Golang layout string explained below but uses a slightly different syntax.
Go's Layout String
Hugo templates format your dates via layout strings that point to a specific reference time:
Mon Jan 2 15:04:05 MST 2006
While this may seem arbitrary, the numerical value of MST is 07, thus making the layout string a sequence of numbers.
Here is a visual explanation taken directly from the Go docs:
Jan 2 15:04:05 2006 MST
=> 1 2 3 4 5 6 -7
Hugo Date and Time Templating Reference
The following examples show the layout string followed by the rendered output.
The examples were rendered and tested in CST and all point to the same field in a content file's front matter:
date: 2017-03-03T14:15:59-06:00
.Date(i.e. called via page variable)- Returns:
2017-03-03 14:15:59 -0600 CST "Monday, January 2, 2006"- Returns:
Friday, March 3, 2017 "Mon Jan 2 2006"- Returns:
Fri Mar 3 2017 "January 2nd"- Returns:
March 3rd "January 2006"- Returns:
March 2017 "2006-01-02"- Returns:
2017-03-03 "Monday"- Returns:
Friday "02 Jan 06 15:04 MST"(RFC822)- Returns:
03 Mar 17 14:15 CST "02 Jan 06 15:04 -0700"(RFC822Z)- Returns:
03 Mar 17 14:15 -0600 "Mon, 02 Jan 2006 15:04:05 MST"(RFC1123)- Returns:
Fri, 03 Mar 2017 14:15:59 CST "Mon, 02 Jan 2006 15:04:05 -0700"(RFC339)- Returns:
Fri, 03 Mar 2017 14:15:59 -0600
Cardinal Numbers and Ordinal Abbreviations
Spelled-out cardinal numbers (e.g. "one", "two", and "three") and ordinal abbreviations (i.e., with shorted suffixes like "1st", "2nd", and "3rd") are not currently supported:
{{.Date.Format "Jan 2nd 2006"}}
Hugo assumes you want to append nd as a string to the day of the month and outputs the following:
Mar 3nd 2017
Use .Local and .UTC
In conjunction with the dateFormat function, you can also convert your dates to UTC or to local timezones:
{{ dateFormat "02 Jan 06 15:04 MST" .Date.UTC }}- Returns:
03 Mar 17 20:15 UTC {{ dateFormat "02 Jan 06 15:04 MST" .Date.Local }}- Returns:
03 Mar 17 14:15 CST