diff options
| author | Thomas O'Donnell <andytom@users.noreply.github.com> | 2022-06-18 23:23:59 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-18 23:23:59 +0200 |
| commit | 67619386cdd7537f0ab9af77e701409e97a87917 (patch) | |
| tree | 52284760a3597e753393a5344a10cc6ce1f66c3d /docs/config/README.md | |
| parent | 2ffe1737f06db4ce89a21b2b5238f3ad76c94bca (diff) | |
fix(character): Standadise Vim config names (#4081)
Have switched all vi/vim symbols to have the same prefix 'vim'. To
preserve backwards compatibility with existing configs I have added an
alias for the previous config name.
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index f1acd4ccd..f7965e5db 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -561,7 +561,7 @@ look at [this example](#with-custom-error-shape). ::: warning -`vicmd_symbol` is only supported in cmd, fish and zsh. +`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). @@ -569,16 +569,16 @@ 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. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `vicmd_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 replace 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. | +| `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 replace mode. | +| `disabled` | `false` | Disables the `character` module. | ### Variables |