summaryrefslogtreecommitdiffstats
path: root/docs/advanced-config/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/advanced-config/README.md')
-rw-r--r--docs/advanced-config/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/advanced-config/README.md b/docs/advanced-config/README.md
index 15698e330..4fc029830 100644
--- a/docs/advanced-config/README.md
+++ b/docs/advanced-config/README.md
@@ -141,6 +141,28 @@ Produces a prompt like the following:
▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
```
+## Continuation Prompt
+
+Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).
+
+Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[❯](bold yellow)"`.
+
+Note: `continuation_prompt` should be set to a literal string without any variables.
+
+Note: Continuation prompts are only available in the following shells:
+
+ - `bash`
+ - `zsh`
+ - `PowerShell`
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+# A continuation prompt that displays two filled in arrows
+continuation_prompt = "▶▶"
+```
## Style Strings