Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-26 11:37:32 +00:00
Code Issues Releases Activity

docs: Add undocumented config options (#262)

Browse Source
This commit is contained in:
Matan Kushner 2019-08-29 13:09:36 -04:00 committed by GitHub
parent 9918dd1aac
commit c121dd4d44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/config/README.md
View File

@ -63,7 +63,9 @@ prompt_order=["rust","line_break","package","line_break","character"]
``` ```
### Default prompt order ### Default prompt order
The ```default_prompt_order``` configuration option is used to define the order in which modules are shown in the prompt, if empty or no ```prompt_order``` is provided. The default is as shown:
The `default_prompt_order` configuration option is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown:
``` ```
default_prompt_order = [ default_prompt_order = [
"username", "username",
@ -84,7 +86,6 @@ default_prompt_order = [
] ]
``` ```
## Battery ## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The `battery` module shows how charged the device's battery is and its current charging status.
@ -188,12 +189,12 @@ it would have been `nixpkgs/pkgs`.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ------------------- | ------- | -------------------------------------------------------------------------------- | | --------------------------- | ------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | | `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `disabled` | `false` | Disables the `directory` module. | | `disabled` | `false` | Disables the `directory` module. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
### Example ### Example
@ -301,10 +302,11 @@ more than the `threshold` config value, if it exists.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ----------- | ------- | -------------------------------- | | ----------- | ------- | ----------------------------------------------------- |
| `threshold` | `1` | Show number of jobs if exceeded. | | `symbol` | `"✦ "` | The symbol used before displaying the number of jobs. |
| `disabled` | `false` | Disables the `jobs` module. | | `threshold` | `1` | Show number of jobs if exceeded. |
| `disabled` | `false` | Disables the `jobs` module. |
### Example ### Example
@ -312,6 +314,7 @@ more than the `threshold` config value, if it exists.
# ~/.config/starship.toml # ~/.config/starship.toml
[jobs] [jobs]
symbol = "+ "
threshold = 4 threshold = 4
``` ```
@ -346,6 +349,7 @@ The module will be shown if any of the following conditions are met:
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------- | --------------------------- | | ---------- | ------- | --------------------------- |
| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. |
| `disabled` | `false` | Disables the `ruby` module. | | `disabled` | `false` | Disables the `ruby` module. |
### Example ### Example
@ -354,7 +358,7 @@ The module will be shown if any of the following conditions are met:
# ~/.config/starship.toml # ~/.config/starship.toml
[ruby] [ruby]
disabled = false symbol = "🔺 "
``` ```
## NodeJS ## NodeJS
@ -462,10 +466,10 @@ 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 Rust. | | `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. |
| `disabled` | `false` | Disables the `rust` module. | | `disabled` | `false` | Disables the `rust` module. |
### Example ### Example
@ -509,7 +513,7 @@ The module will be shown when inside a nix-shell environment.
| Variable | Default | Description | | Variable | Default | Description |
| ------------ | -------- | ---------------------------------- | | ------------ | -------- | ---------------------------------- |
| `disabled` | `false` | Disables the `nix_shell` module. | | `disabled` | `false` | Disables the `nix_shell` module. |
| `use_name` | `false` | Display the name of the nix-shell. | | `use_name` | `false` | Display the name of the nix-shell. |
| `impure_msg` | `impure` | Customize the "impure" msg. | | `impure_msg` | `impure` | Customize the "impure" msg. |
| `pure_msg` | `pure` | Customize the "pure" msg. | | `pure_msg` | `pure` | Customize the "pure" msg. |