Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-24 21:57:41 +00:00
Code Issues Releases Activity

docs: Improve doc consistency

Browse Source
This commit is contained in:
Matan Kushner 2019-12-06 12:00:15 -05:00
parent 7d1c0f6b9f
commit 9f574eaabd
No known key found for this signature in database
GPG Key ID: 4B98C3A8949CA8A4
1 changed files with 42 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
docs/config/README.md
View File

@ -126,8 +126,8 @@ The `aws` module shows the current AWS region and profile. This is based on
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ----------------- | --------------- | ----------------------------------------------------------------------------| | ----------------- | --------------- | --------------------------------------------------------------------------- |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] | | `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] |
@ -369,8 +369,8 @@ setting `heuristic = false` in the module options.
| Variable | Default | Description | | Variable | Default | Description |
| ----------- | ------------- | -------------------------------------------------------- | | ----------- | ------------- | -------------------------------------------------------- |
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | | `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
| `style` | `"bold blue"` | The style for the module. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `disabled` | `false` | Disables the `dotnet` module. |
### Example ### Example
@ -439,7 +439,6 @@ truncation_length = 4
truncation_symbol = "" truncation_symbol = ""
``` ```
## Git Commit ## Git Commit
The `git_commit` module shows the active branch of the repo in your current directory. The `git_commit` module shows the active branch of the repo in your current directory.
@ -453,13 +452,13 @@ To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Variable | Default | Description | | Variable | 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. |
| `style` | `"green"` | The style for the module. | | `prefix` | `(` | Prefix to display immediately before git commit. |
| `prefix` | `(` | Prefix to display immediately before git commit. | | `suffix` | `)` | Suffix to display immediately after git commit. |
| `suffix` | `)` | Suffix to display immediately after git commit. | | `style` | `"bold green"` | The style for the module. |
| `disabled` | `true` | Disables the `git_commit` module. | | `disabled` | `true` | Disables the `git_commit` module. |
### Example ### Example
@ -510,37 +509,36 @@ current directory.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ------------------- | -------------------------- | --------------------------------------------------------------- | | ------------------ | -------------------------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. | | `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. | | `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. | | `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. | | `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. | | `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. | | `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. | | `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. | | `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. | | `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. | | `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. | | `staged` | `"+"` | A new file has been added to the staging area. |
| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. | | `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. | | `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. | | `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. | | `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. | | `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. | | `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. | | `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. | | `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
#### Git Status Counts #### Git Status Counts
| Variable | Default | Description | | Variable | Default | Description |
| ----------- | ------- | ------------------------------------------------------ | | --------- | ------- | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files | | `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module | | `style` | | Optionally style the count differently than the module |
### Example ### Example
@ -884,11 +882,11 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------------ | ------------------------------------------------------ | | ---------- | ------------ | ----------------------------------------------------- |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `php` module. | | `disabled` | `false` | Disables the `php` module. |
### Example ### Example