Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-28 15:56:28 +00:00
Code Issues Releases Activity

docs: A few small improvements

Browse Source 
- Correctly alphebetize modules
- Fix table formatting
- Add missing quotes around strings
This commit is contained in:
Matan Kushner 2019-12-23 18:10:20 -05:00
parent 4f5d1bc8f3
commit e53ced8221
No known key found for this signature in database
GPG Key ID: 4B98C3A8949CA8A4
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/config/README.md
View File

@ -128,7 +128,7 @@ 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. |
| `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`] |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
@ -746,8 +746,8 @@ The module will be shown when inside a nix-shell environment.
| Variable | Default | Description | | Variable | Default | Description |
| ------------ | ------------ | ---------------------------------- | | ------------ | ------------ | ---------------------------------- |
| `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. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `nix_shell` module. | | `disabled` | `false` | Disables the `nix_shell` module. |
@ -763,6 +763,31 @@ impure_msg = "impure shell"
pure_msg = "pure shell" pure_msg = "pure shell"
``` ```
## Java
The `java` module shows the currently installed version of Java.
The module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle`, `build.gradle.kts` or `build.sbt` file
- The current directory contains a file with the `.java`, `.class` or `.jar` extension
### Options
| Variable | Default | Description |
| ---------- | -------------- | ------------------------------------------------------ |
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
| `style` | `"dimmed red"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Example
```toml
# ~/.config/starship.toml
[java]
symbol = "🌟 "
```
## Memory Usage ## Memory Usage
The `memory_usage` module shows current system memory and swap usage. The `memory_usage` module shows current system memory and swap usage.
@ -802,31 +827,6 @@ separator = "/"
style = "bold dimmed green" style = "bold dimmed green"
``` ```
## Java
The `java` module shows the currently installed version of Java.
The module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle`, `build.gradle.kts` or `build.sbt` file
- The current directory contains a file with the `.java`, `.class` or `.jar` extension
### Options
| Variable | Default | Description |
| ---------- | -------------- | ------------------------------------------------------ |
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
| `style` | `"dimmed red"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Example
```toml
# ~/.config/starship.toml
[java]
symbol = "🌟 "
```
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The `nodejs` module shows the currently installed version of NodeJS.