summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-08-17 16:38:20 -0400
committerGitHub <noreply@github.com>2019-08-17 16:38:20 -0400
commit7475c3dd72b23ed922f512af9a534ded304416f3 (patch)
tree814a96759400ca90be27f0f9951b71762c5ac4ce
parent421d22ed5c18dfebf11cdd4dbc652c0bef0b8765 (diff)
docs: Small doc touch-ups (#176)
-rw-r--r--README.md42
-rw-r--r--docs/config/README.md40
2 files changed, 41 insertions, 41 deletions
diff --git a/README.md b/README.md
index e57525e05..8c81299db 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,6 @@
<h1></h1>
-
Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br>
The prompt shows information you need while you're working, while staying sleek and out of the way.
@@ -57,7 +56,10 @@ The prompt shows information you need while you're working, while staying sleek
- Current Ruby version (`💎`).
- Current Python version (`🐍`)
- Current Go version (`🐹`)
-- Package version of package in current directory (`📦`)
+- Current version of package in current directory (`📦`)
+ - npm (Node.js)
+ - cargo (Rust)
+ - poetry (Python)
- Current battery level and status
- Current Git branch and rich repo status:
- `=` — conflicting changes
@@ -99,35 +101,35 @@ The prompt shows information you need while you're working, while staying sleek
1. Add the init script to your shell's config file:
- #### Bash
+ #### Bash
- Add the following to the end of `~/.bashrc`:
+ Add the following to the end of `~/.bashrc`:
- ```sh
- # ~/.bashrc
+ ```sh
+ # ~/.bashrc
- eval "$(starship init bash)"
- ```
+ eval "$(starship init bash)"
+ ```
- #### Fish
+ #### Fish
- Add the following to the end of `~/.config/fish/config.fish`:
+ Add the following to the end of `~/.config/fish/config.fish`:
- ```sh
- # ~/.config/fish/config.fish
+ ```sh
+ # ~/.config/fish/config.fish
- eval (starship init fish)
- ```
+ eval (starship init fish)
+ ```
- #### Zsh
+ #### Zsh
- Add the following to the end of `~/.zshrc`:
+ Add the following to the end of `~/.zshrc`:
- ```sh
- # ~/.zshrc
+ ```sh
+ # ~/.zshrc
- eval "$(starship init zsh)"
- ```
+ eval "$(starship init zsh)"
+ ```
## 🔧 Configuration
diff --git a/docs/config/README.md b/docs/config/README.md
index 8c3814f7d..d31a010f4 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -89,19 +89,19 @@ discharging_symbol = "💀"
The `character` module shows a character (usually an arrow) beside where the text
is entered in your terminal.
-The character will tell you whether the last command was successful or not. It
-can do this in two ways: by changing color (red/green) or by changing its shape
+The character will tell you whether the last command was successful or not. It
+can do this in two ways: by changing color (red/green) or by changing its shape
(➜/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
### Options
-| Variable | Default | Description |
-| ---------- | ------- | ---------------------------------------------------- |
-| `symbol` | `"➜"` | The symbol used before the text input in the prompt. |
-| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
-| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
+| Variable | Default | Description |
+| ----------------------- | ------- | --------------------------------------------------------------------------------- |
+| `symbol` | `"➜"` | The symbol used before the text input in the prompt. |
+| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
+| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if zsh is in vim normal mode. |
-| `disabled` | `false` | Disables the `character` module. |
+| `disabled` | `false` | Disables the `character` module. |
### Example
@@ -120,14 +120,14 @@ The `cmd_duration` module shows how long the last command took to execute.
The module will be shown only if the command took longer than two seconds, or
the `min_time` config value, if it exists.
-::: warning Do Not Hook the DEBUG trap in Bash
+::: warning Do not hook the DEBUG trap in Bash
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running
`eval $(starship init $0)`, or this module **will** break.
:::
Bash users who need preexec-like functionality can use
[rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec).
-Simply define the arrays `preexec_functions` and `precmd_functions` before
+Simply define the arrays `preexec_functions` and `precmd_functions` before
running `eval $(starship init $0)`, and then proceed as normal.
### Options
@@ -309,9 +309,9 @@ The module will be shown if any of the following conditions are met:
### Options
-| Variable | Default | Description |
-| ---------- | ------- | -------------------------------------------------------- |
-| `disabled` | `false` | Disables the `ruby` module. |
+| Variable | Default | Description |
+| ---------- | ------- | --------------------------- |
+| `disabled` | `false` | Disables the `ruby` module. |
### Example
@@ -398,13 +398,12 @@ 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 Python. |
-| `disabled` | `false` | Disables the `python` module. |
-| `pyenv_version_name` | `false` | Use pyenv to get Python version |
-| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
-
+| Variable | Default | Description |
+| -------------------- | ---------- | --------------------------------------------------------------------------- |
+| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
+| `disabled` | `false` | Disables the `python` module. |
+| `pyenv_version_name` | `false` | Use pyenv to get Python version |
+| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
### Example
@@ -464,4 +463,3 @@ The module will be shown if any of the following conditions are met:
[username]
disabled = true
```
-