extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-12-03 13:46:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: correct the configuration docs (#1195)

Browse Source
This commit is contained in:
Thomas O'Donnell 2020-05-14 00:19:21 +02:00 committed by GitHub
parent 5dcdba5135
commit 9251778a9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/config/README.md
View File

@ -480,8 +480,9 @@ 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 Elixir/Erlang. | | `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. | | `disabled` | `false` | Disables the `elixir` module. |
### Example ### Example
@ -522,29 +523,6 @@ The module will be shown if any of the following conditions are met:
symbol = " " symbol = " "
``` ```
## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP.
The module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
### Options
| Variable | Default | Description |
| ---------- | ------- | --------------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
| `disabled` | `false` | Disables the `erlang` module. |
### Example
```toml
# ~/.config/starship.toml
[erlang]
symbol = "e "
```
## Environment Variable ## Environment Variable
The `env_var` module displays the current value of a selected environment variable. The `env_var` module displays the current value of a selected environment variable.
@ -556,13 +534,13 @@ The module will be shown only if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ---------------- | ---------------------------------------------------------------------------- | | ---------- | --------------------- | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. | | `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. | | `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. | | `default` | | The default value to be displayed when the selected variable is not defined. |
| `prefix` | `""` | Prefix to display immediately before the variable value. | | `prefix` | `""` | Prefix to display immediately before the variable value. |
| `suffix` | `""` | Suffix to display immediately after the variable value. | | `suffix` | `""` | Suffix to display immediately after the variable value. |
| `style` | `"dimmed black"` | The style for the module. | | `style` | `"dimmed bold black"` | The style for the module. |
| `disabled` | `false` | Disables the `env_var` module. | | `disabled` | `false` | Disables the `env_var` module. |
### Example ### Example
@ -575,6 +553,31 @@ variable = "SHELL"
default = "unknown shell" default = "unknown shell"
``` ```
## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP.
The module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
### Options
| Variable | Default | Description |
| ---------- | ---------- | --------------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of Erlang. |
| `style` | `bold red` | The style for this module. |
| `disabled` | `false` | Disables the `erlang` module. |
### Example
```toml
# ~/.config/starship.toml
[erlang]
symbol = "e "
```
## Git Branch ## Git Branch
The `git_branch` module shows the active branch of the repo in your current directory. The `git_branch` module shows the active branch of the repo in your current directory.
@ -1077,7 +1080,7 @@ package, and shows its current version. The module currently supports `npm`, `ca
| Variable | Default | Description | | Variable | Default | Description |
| ----------------- | ------------ | ---------------------------------------------------------- | | ----------------- | ------------ | ---------------------------------------------------------- |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold 208"` | The style for the module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. | | `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. | | `disabled` | `false` | Disables the `package` module. |
@ -1104,7 +1107,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 PHP. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold 147"` | The style for the module. |
| `disabled` | `false` | Disables the `php` module. | | `disabled` | `false` | Disables the `php` module. |
### Example ### Example
@ -1118,13 +1121,11 @@ symbol = "🔹 "
## Python ## Python
The `python` module shows the currently installed version of Python. The `python` module shows the currently installed version of Python and the
current Python virtual environment if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. If `pyenv_version_name` is set to `true`, it will display the pyenv version
name. Otherwise, it will display the version number from `python --version`.
Otherwise, it will display the version number from `python --version`
and show the current Python virtual environment if one is
activated.
The module will be shown if any of the following conditions are met: The module will be shown if any of the following conditions are met: