From b29891adf9f581af057c7de2596ce53f6826f1f9 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Sat, 28 Sep 2019 01:17:53 +0900 Subject: [PATCH] docs: Small fixes to the config docs --- docs/config/README.md | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index c1d296ae..81bed205 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -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%. There are also options for some uncommon battery states. | 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`. - ### 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