Skip to content

Commit

Permalink
Added missing documentation for root character symbols
Browse files Browse the repository at this point in the history
  • Loading branch information
@ironiq
ironiq committed Dec 3, 2023
1 parent 6616567 commit 423f139
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions docs/config/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -721,16 +721,18 @@ are only supported in fish due to [upstream issues with mode detection in zsh](h

### Options

| Option | Default | Description |
| --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `'$symbol '` | The format string used before the text input. |
| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| --------------------------- | -------------------- | ------------------------------------------------------------------------------------------- |
| `format` | `'$symbol '` | The format string used before the text input. |
| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |
| `root_success_symbol` | `'[❯](bold blue)'` | The format string used before the text input if the previous command succeeded (root user). |
| `root_error_symbol` | `'[❯](bold purple)` | The format string used before the text input if the previous command failed (root user). |
| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |
| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |
| `disabled` | `false` | Disables the `character` module. |

### Variables

Expand All @@ -748,6 +750,8 @@ are only supported in fish due to [upstream issues with mode detection in zsh](h
[character]
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '
root_success_symbol = '[➜](bold blue) '
root_error_symbol = '[✗](bold purple) '
```

#### Without custom error shape
Expand All @@ -758,6 +762,8 @@ error_symbol = '[✗](bold red) '
[character]
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '
root_success_symbol = '[➜](bold blue) '
root_error_symbol = '[➜](bold purple) '
```

#### With custom vim shape
Expand Down

0 comments on commit 423f139

Please sign in to comment.