mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2024-09-19 21:17:31 -07:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs(time): clarify datetime syntax formats

Browse source
This commit is contained in:
Artin 2024-09-12 08:22:07 +03:30 committed by GitHub
parent ebe2cca232
commit 835350d813
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 44 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
website/docs/segments/system/time.mdx
View file

@ -23,9 +23,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Default | Description |
| ------------- | :------: | :--------: | ---------------------------------------------------- |
| `time_format` | `string` | `15:04:05` | format to use, follows the [golang standard][format] |
| Name | Type | Default | Description |
| ------------- | :------: | :--------: | ------------- |
| `time_format` | `string` | `15:04:05` | Format to use |
## Template ([info][templates])
@ -46,42 +46,49 @@ import Config from '@site/src/components/Config.js';
## Syntax
- January 2, 2006 **Date**
- 01/02/06
- Jan-02-06
- 15:04:05 **Time**
- 3:04:05 PM
- Jan 2 15:04:05 **Timestamp**
- Jan 2 15:04:05.000000 **with microseconds**
- 2006-01-02T15:04:05-0700 **ISO 8601 (RFC 3339)**
- 2006-01-02
- 15:04:05
- 02 Jan 06 15:04 MST **RFC 822**
- 02 Jan 06 15:04 -0700 **with numeric zone**
- Mon, 02 Jan 2006 15:04:05 MST 27e95cb
- Mon, 02 Jan 2006 15:04:05 -0700 **with numeric zone**
### Formats
The following predefined date and timestamp format constants are also available:
Follows the [golang datetime standard][format]:
| DateTime | Format |
| ------------------------------------------------ | ------------------------------------------------------- |
| **Year** | `06`, `2006` |
| **Month** | `01`, `1`, `Jan`, `January` |
| **Day** | `02`, `2`, `_2` <sub>(width two, right justified)</sub> |
| **Weekday** | `Mon`, `Monday` |
| **Hours** | `03`, `3`, `15` |
| **Minutes** | `04`, `4` |
| **Seconds** | `05`, `5` |
| **ms μs ns** | `.000`, `.000000`, `.000000000` |
| **ms μs ns** <sub>(trailing zeros removed)</sub> | `.999`, `.999999`, `.999999999` |
| **am/pm** | `PM`, `pm` |
| **Timezone** | `MST` |
| **Offset** | `-0700`, `-07`, `-07:00`, `Z0700`, `Z07:00` |
### Predefined formats
The following predefined date and timestamp [format constants][format-constants] are also available:
| Name | Format |
| --------------- | ------------------------------------- |
| **ANSIC** | `Mon Jan _2 15:04:05 2006` |
| **UnixDate** | `Mon Jan _2 15:04:05 MST 2006` |
| **RubyDate** | `Mon Jan 02 15:04:05 -0700 2006` |
| **RFC822** | `02 Jan 06 15:04 MST` |
| **RFC822Z** | `02 Jan 06 15:04 -0700` |
| **RFC850** | `Monday, 02-Jan-06 15:04:05 MST` |
| **RFC1123** | `Mon, 02 Jan 2006 15:04:05 MST` |
| **RFC1123Z** | `Mon, 02 Jan 2006 15:04:05 -0700` |
| **RFC3339** | `2006-01-02T15:04:05Z07:00` |
| **RFC3339Nano** | `2006-01-02T15:04:05.999999999Z07:00` |
| **Kitchen** | `3:04PM` |
| **Stamp** | `Jan _2 15:04:05` |
| **StampMilli** | `Jan _2 15:04:05.000` |
| **StampMicro** | `Jan _2 15:04:05.000000` |
| **StampNano** | `Jan _2 15:04:05.000000000` |
| Name | Output |
| ------------- | ----------------------------------- |
| `ANSIC` | Mon Jan 2 15:04:05 2006 |
| `UnixDate` | Mon Jan 2 15:04:05 MST 2006 |
| `RubyDate` | Mon Jan 02 15:04:05 -0700 2006 |
| `RFC822` | 02 Jan 06 15:04 MST |
| `RFC822Z` | 02 Jan 06 15:04 -0700 |
| `RFC850` | Monday, 02-Jan-06 15:04:05 MST |
| `RFC1123` | Mon, 02 Jan 2006 15:04:05 MST |
| `RFC1123Z` | Mon, 02 Jan 2006 15:04:05 -0700 |
| `RFC3339` | 2006-01-02T15:04:05Z07:00 |
| `RFC3339Nano` | 2006-01-02T15:04:05.999999999Z07:00 |
| `Kitchen` | 3:04PM |
| `Stamp` | Jan 2 15:04:05 |
| `StampMilli` | Jan 2 15:04:05.000 |
| `StampMicro` | Jan 2 15:04:05.000000 |
| `StampNano` | Jan 2 15:04:05.000000000 |
## Examples
@ -93,4 +100,5 @@ To display the time in multiple time zones, using [Sprig's Date Functions][sprig
[templates]: /docs/configuration/templates
[format]: https://yourbasic.org/golang/format-parse-string-time-date-example/
[format-constants]: https://golang.org/pkg/time/#pkg-constants
[sprig-date]: https://masterminds.github.io/sprig/date.html