haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Small fixes to the config docs

This commit is contained in:
Matan Kushner 2019-09-28 01:17:53 +09:00
parent f0298ecb8a
commit b29891adf9
No known key found for this signature in database
GPG Key ID: 4B98C3A8949CA8A4
1 changed files with 17 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/config/README.md
View File

@ -113,11 +113,11 @@ The `aws` module shows the current AWS profile. This is based on the
### Options
| Variable | Default | Description |
| ---------- | --------------- | ---------------------------------------------------- |
| `disabled` | `false` | Disables the `AWS` module |
| `style` | `"bold yellow"` | The style used for the module |
| `symbol` | `"☁️ "` | The symbol before displaying the current AWS profile |
| Variable | Default | Description |
| ---------- | --------------- | ---------------------------------------------------------- |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `AWS` module. |
### Example
@ -148,7 +148,7 @@ The module is only visible when the device's battery is below 10%.
<summary>There are also options for some uncommon battery states.</summary>
| Variable | Description |
|------------------|-----------------------------------------------------|
| ---------------- | --------------------------------------------------- |
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | The symbol shown when the battery state is empty. |
@ -300,7 +300,6 @@ it would have been `nixpkgs/pkgs`.
</details>
### Example
```toml
@ -470,7 +469,6 @@ The module will be shown if any of the following conditions are met:
symbol = "🏎💨 "
```
## Hostname
The `hostname` module shows the system hostname.
@ -497,7 +495,6 @@ suffix = "⟫"
disabled = false
```
## Jobs
The `jobs` module shows the current number of jobs running.
@ -543,7 +540,6 @@ The `line_break` module separates the prompt into two lines.
disabled = true
```
## Nix-shell
The `nix_shell` module shows the nix-shell environment.
@ -581,11 +577,11 @@ The module will be shown if any of the following conditions are met:
### 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. |
| 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
@ -596,7 +592,6 @@ The module will be shown if any of the following conditions are met:
symbol = "🌟 "
```
## NodeJS
The `nodejs` module shows the currently installed version of NodeJS.
@ -790,12 +785,12 @@ The module will be shown if any of the following conditions are met:
### Options
| Variable | Default | Description |
| ------------ | --------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `show_always`| `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
| Variable | Default | Description |
| ------------- | --------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
### Example