summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Knaack <davidkna@users.noreply.github.com>2021-02-02 12:59:55 +0100
committerGitHub <noreply@github.com>2021-02-02 12:59:55 +0100
commit22dc8b842e721c440aa98035dd2dff30c7fe6497 (patch)
treeb4b15a181a96c75c6448e5f1a3d2ee9f1ae64973 /docs
parent10d5a7034b006e8eacb1748cd27c020b614ded9f (diff)
feat: add support for elvish shell (#1725)
* feat: add support for elvish shell * improve doc * elvish 0.15 is out * fix example init * update systax for 0.15 stable * udpate second init example too * remove warning from swift module * add warning to status module docs * prefix elvish version with v
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md14
-rw-r--r--docs/config/README.md8
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index c3022b298..5fdedb9cf 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -101,3 +101,17 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
eval $(starship init ion)
```
+ #### Elvish
+
+ ::: warning
+ Only elvish v0.15 or higher is supported.
+ :::
+
+ Add the following to the end of `~/.elvish/rc.elv`:
+
+ ```sh
+ # ~/.elvish/rc.elv
+
+ eval (starship init elvish)
+ ```
+
diff --git a/docs/config/README.md b/docs/config/README.md
index 7a1b8a68d..790f23488 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -388,6 +388,10 @@ can do this in two ways:
By default it only changes color. If you also want to change it's shape take a
look at [this example](#with-custom-error-shape).
+
+::: warning
+`error_symbol` is not supported on elvish shell.
+:::
### Options
@@ -2263,6 +2267,10 @@ To enable it, set `disabled` to `false` in your configuration file.
:::
+::: warning
+This module is not supported on elvish shell.
+:::
+
### Options
| Option | Default | Description |