From e53ced82216479a7d7137604af55f5d71c51a84a Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Mon, 23 Dec 2019 18:10:20 -0500 Subject: [PATCH] docs: A few small improvements - Correctly alphebetize modules - Fix table formatting - Add missing quotes around strings --- docs/config/README.md | 58 +++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 094b8773..8e83fe90 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -128,8 +128,8 @@ The `aws` module shows the current AWS region and profile. This is based on ### Options | 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`] | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `style` | `"bold yellow"` | The style for the module. | @@ -746,8 +746,8 @@ The module will be shown when inside a nix-shell environment. | Variable | Default | Description | | ------------ | ------------ | ---------------------------------- | | `use_name` | `false` | Display the name of the nix-shell. | -| `impure_msg` | `impure` | Customize the "impure" msg. | -| `pure_msg` | `pure` | Customize the "pure" msg. | +| `impure_msg` | `"impure"` | Customize the "impure" msg. | +| `pure_msg` | `"pure"` | Customize the "pure" msg. | | `style` | `"bold red"` | The style for the module. | | `disabled` | `false` | Disables the `nix_shell` module. | @@ -763,6 +763,31 @@ impure_msg = "impure 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 The `memory_usage` module shows current system memory and swap usage. @@ -802,31 +827,6 @@ separator = "/" 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 The `nodejs` module shows the currently installed version of NodeJS.