hugo/docs/content/en/functions/dateformat.md
2023-05-22 16:47:07 +02:00

1.6 KiB
Raw Blame History

title description categories menu keywords signature relatedfuncs
time.Format Converts a date/time to a localized string.
functions
docs
parent
functions
dates
time
strings
time.Format LAYOUT INPUT
dateFormat LAYOUT INPUT
Format
now
Unix
time

time.Format (alias dateFormat) converts either a time.Time object (e.g. .Date) or a timestamp string INPUT into the format specified by the LAYOUT string.

{{ time.Format "Monday, Jan 2, 2006" "2015-01-21" }} → "Wednesday, Jan 21, 2015"

time.Format returns a localized string for the current language.

The LAYOUT string can be either:

  • Gos Layout String to learn about how the LAYOUT string has to be formatted. There are also some useful examples.
  • A custom Hugo layout identifier (see full list below)

See the time function to convert a timestamp string to a Go time.Time type value.

Date/time formatting layouts

Go's date layout strings can be hard to reason about, especially with multiple languages. You can alternatively use some predefined layout identifiers that will output localized dates or times:

{{ .Date | time.Format ":date_long" }}

The full list of custom layouts with examples for English:

  • :date_full => Wednesday, June 6, 2018

  • :date_long => June 6, 2018

  • :date_medium => Jun 6, 2018

  • :date_short => 6/6/18

  • :time_full => 2:09:37 am UTC

  • :time_long => 2:09:37 am UTC

  • :time_medium => 2:09:37 am

  • :time_short => 2:09 am