hugo/content/en/functions/format.md
Bjørn Erik Pedersen 83bef6955e Squashed 'docs/' changes from 896bad9f4..e161ea09d
e161ea09d Add one more Chinese file to workaround reflect: Zero(nil)
b595b3a21 Add more Chinese translation
56e4e95d9 Use lang.Merge to "fill in the gaps" for untranslated pages
ef079406c Merge commit '650fac3a4e7d256f4505402ab44cfc3c804b8dea'
650fac3a4 Squashed 'themes/gohugoioTheme/' changes from a1768ebb..f31a3dc8
322eff899 Add Chinese language for menus
d90b886e0 Fix Markdown table syntax in previous commit
737f3dfca Update the leaf bundle vs branch bundle table
09fa1bc4e Clarify that `.Now` is obsolete
879ea3f6a Make release notes somewhat more consistent
0113e2051 Move 0.40.2-relnotes into content/en/news
77578f5bf Move content/ into new contentDir content/en/
4dcf7c709 Fix "reflect: Zero(nil)" error in showcase
63dd25505 Release 0.40.2
2076c0d56 releaser: Prepare repository for 0.41-DEV
070fe565e releaser: Add release notes to /docs for release of 0.40.2
4ce52e913 releaser: Bump versions for release of 0.40.2
41907c487 Fix typos in syntax-highlighting.md
91753ef3d Add missing backtick
b77274301 Remove duplicate release notes (0.27, 0.27.1, 0.35)
6e00da316 Remove obsolete content/release-notes/ directory
00a6d8c02 Change en dash back to `--` in 0.38.2-relnotes
51b32dc00 Update archetypes.md
d0e5c2307 Release 0.40.1
4538a6d5b releaser: Prepare repository for 0.41-DEV
91b391d70 releaser: Add release notes to /docs for release of 0.40.1
e0979d143 releaser: Bump versions for release of 0.40.1
7983967c2 Clean images
fe3fdd77d Polish showcase for Flesland Flis
e6dde3989 Showcase - Flesland Flis AS by Absoluttweb
73aa62290 Revive @spf13's special Hugo font
add67b335 Release Hugo 0.40
c0a26e5a6 Merge branch 'temp40'
beeabaaae releaser: Prepare repository for 0.41-DEV
e67d5e985 releaser: Add release notes to /docs for release of 0.40
6cdd95273 releaser: Bump versions for release of 0.40
bee21fb9b Revive the other Hugo logos too
4f45e8fe1 Fix the link type attribute for RSS in examples
8c67dc89a Fix example in delimit doc
e7f6c00d5 Revive the logo used on the forum
82b0cd26e Merge commit 'a215abf70e018f4bf40d6c09d8bd148d8684b33d'
119c8ca58 Merge commit 'd2ec1a06df8ab6b17ad05cb008d5701b40327d47'
db4683bd2 Improve .Get docs
05260b886 .Get function: fix syntax signature

git-subtree-dir: docs
git-subtree-split: e161ea09d33e3199f4998e4d2e9068d5a850f042
2018-05-04 09:44:21 +02:00

3.5 KiB

title description godocref date publishdate lastmod categories menu keywords 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
functions
docs
parent
functions
dates
time
.Format FORMAT
times
dateFormat
now
Unix
time
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 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