Skip to content

Commit

Permalink
docs: Small fixes to the config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
matchai committed Sep 27, 2019
1 parent f0298ec commit b29891a
Showing 1 changed file with 17 additions and 22 deletions.
39 changes: 17 additions & 22 deletions docs/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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. |

Expand Down Expand Up @@ -300,7 +300,6 @@ it would have been `nixpkgs/pkgs`.

</details>


### Example

```toml
Expand Down Expand Up @@ -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.
Expand All @@ -497,7 +495,6 @@ suffix = "⟫"
disabled = false
```


## Jobs

The `jobs` module shows the current number of jobs running.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit b29891a

Please sign in to comment.