mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
aa5ac36a3e
39a7fac34 Add .hugo_build.lock to .gitignore 920c716a4 fix a typo: to -> two (#1545) 6f0ba9593 Remove godocref from front matter (#1543) 8ec3d5948 remove link to wercker (#1544) b56008719 Delete deployment-with-wercker.md (#1542) e33d29b02 Fix broken links (#1538) 29e9d4c21 Sort commenting systems (#1541) 0b7ea60a7 Delete the news page "HTTP/2 Server Push in Hugo" 6e1515857 Fix quick-start.md (#1525) 62168ab35 Update comments.md (#1535) d92191512 Small typo (#1539) 129c8834a Correct the PostCSS noMap default value (#1534) 6a5b29fcc Add example to index function (#1536) e3dd8c507 Update output-formats.md 0c9321ca0 Remove reference to using LiveReload in production environment 4072d6776 Mod testing 09fabf7d6 Fix typo (#1524) 2fce813c8 Fix grammatical error in quick-start.md (#1523) 45230ab4a Hugo Mod testing 2dd4cd9e7 Update index.md 2c3ed62fd netlify: Bump to 0.88.1 648e2a007 Merge branch 'tempv0.88.1' f216eade1 releaser: Add release notes to /docs for release of 0.88.1 8a7b64d4b Fix typographical errors in 0.88.0 release notes a4bf86300 Release 0.88 738bb8f38 releaser: Add release notes to /docs for release of 0.88.0 8fcf2c55d highlight: Remove some pygments references f2b173de2 HTTPS link c88881c8e Adding link to nginx documentation 6b0a74fe0 Fix typos in docs (#1516) 498b8f0f1 Fix typos in time.Format (#1515) 28723fad6 Fix taxonomy and term examples (#1514) 3ffd00e12 Update front-matter.md 7cc1da82e Fix grammar in 0.86.1 release notes (#1510) 0009c51c3 Update docs helper 7e2f430f4 Update index.md 7857eae7e releaser: Add release notes to /docs for release of 0.87.0 1f08b684b releaser: Add release notes to /docs for release of 0.87.0 36a9e701c docs: Adjust config docs 0f588438e docs: Regen CLI docs 1b4682cd8 docs: Regen docs helper bc8bbaae9 Merge commit 'bd77f6e1c99e04a476f0b1bb4e44569134e02399' into release-0.87.0 6f2480643 docs: Adjust time zone docs git-subtree-dir: docs git-subtree-split: 39a7fac343c289906db644c96079fdcc0298582f
55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
---
|
||
title: time.Format
|
||
description: Converts a date/time to a localized string.
|
||
date: 2017-02-01
|
||
publishdate: 2017-02-01
|
||
lastmod: 2017-02-01
|
||
categories: [functions]
|
||
menu:
|
||
docs:
|
||
parent: "functions"
|
||
keywords: [dates,time,strings]
|
||
signature: ["time.Format LAYOUT INPUT"]
|
||
workson: []
|
||
hugoversion:
|
||
relatedfuncs: [Format,now,Unix,time]
|
||
deprecated: false
|
||
---
|
||
|
||
`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.
|
||
|
||
```go-html-template
|
||
{{ time.Format "Monday, Jan 2, 2006" "2015-01-21" }} → "Wednesday, Jan 21, 2015"
|
||
```
|
||
|
||
Note that since Hugo 0.87.0, `time.Format` will return a localized string for the current language. {{< new-in "0.87.0" >}}
|
||
|
||
The `LAYOUT` string can be either:
|
||
|
||
* [Go’s Layout String](/functions/format/#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](/functions/time/) to convert a timestamp string to a Go `time.Time` type value.
|
||
|
||
|
||
## Date/time formatting layouts
|
||
|
||
{{< new-in "0.87.0" >}}
|
||
|
||
Go's date layout strings can be hard to reason about, especially with multiple languages. Since Hugo 0.87.0 you can alternatively use some predefined layout identifiers that will output localized dates or times:
|
||
|
||
```go-html-template
|
||
{{ .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`
|