mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
da16527896
4c1309cdf Fix broken link to front matter page (#1923) 8181fff20 Add footnote to Quick Start guide for Win users (#1922) 4fd934f61 Fix abslangurl.md (#1919) bf2c45617 Quick start guide: fix broken links (#1915) 201b568df Update theme 874db199d Hide the news stripe on front page for now aaf59e3e2 netlify: Hugo 0.107.0 79654c301 Merge branch 'tempv107' 8345e0347 docs: Regen docs helper b5b4f15f9 Add assets directory to directory structure diagram (#1917) 76dd3a82a Follow-up: improve function signatures (#1914) (#1916) 656dc72ba Improving function signatures (#1914) b715e8407 Explain how to create multilingual content (#1912) 8500ee417 Fix typo in Quick Start guide ce60bb572 Add docu for undocumented functions (#1907) 372bf5e88 Improve Quick Start tutorial 71e81ec5f Remove asciicast from site 1e56c653f Update hosting-on-cloudflare-pages.md (#1903) 1686f60b1 Adding documentation page for function 'strings.FirstUpper' (#1901) d533f7c9c Fixing typos (#1900) 2563eee45 Update multilingual.md (#1899) 2173ed799 Update theme 5591b8875 Update urls.md (#1897) 4a88890b5 netlify: Hugo 0.106.0 512879fdd docs: Regen CLI docs f74b1d87d docs: Regenerate docs helper 9feacb48f Merge commit '00c4484c7092181729f6f470805bc7d72e8ad17b' git-subtree-dir: docs git-subtree-split: 4c1309cdfe9858434684352f9d544bf0c5c9d646
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"
|
||
- "dateFormat 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"
|
||
```
|
||
|
||
`time.Format` returns a localized string for the current language.
|
||
|
||
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
|
||
|
||
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:
|
||
|
||
```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`
|