1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-11 15:51:01 +00:00

docs: update git_commit default format (#2898)

This commit is contained in:
Alex L 2021-07-18 04:55:07 +08:00 committed by GitHub
parent 31932c2990
commit cacb0a685f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1189,7 +1189,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
| Option | Default | Description | | Option | Default | Description |
| -------------------- | ---------------------------------------------- | ------------------------------------------------------- | | -------------------- | ---------------------------------------------- | ------------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. | | `format` | `"[\\($hash$tag\\)]($style) "` | The format for the module. |
| `style` | `"bold green"` | The style for the module. | | `style` | `"bold green"` | The style for the module. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |