summaryrefslogtreecommitdiff
path: root/docs/getting_started
diff options
context:
space:
mode:
authorPrabhanjan <24642451+Sparkenstein@users.noreply.github.com>2020-08-10 09:20:29 +0530
committerGitHub <noreply@github.com>2020-08-09 23:50:29 -0400
commitfdb2dab7cd59a70b79704e0a0efca44be2bfc186 (patch)
tree7d6bd510d415d1e84aaeedb970c27e64b0e0534a /docs/getting_started
parent67fe8cd8484611a1cbd72d058539920d09b18cfc (diff)
docs: instructions for loading zsh completions (#6998)
Diffstat (limited to 'docs/getting_started')
-rw-r--r--docs/getting_started/setup_your_environment.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/docs/getting_started/setup_your_environment.md b/docs/getting_started/setup_your_environment.md
index 8f34a70ef..89532ce07 100644
--- a/docs/getting_started/setup_your_environment.md
+++ b/docs/getting_started/setup_your_environment.md
@@ -36,14 +36,35 @@ deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
source /usr/local/etc/bash_completion.d/deno.bash
```
-Example (zsh):
+Example (zsh without framework):
+
+```shell
+mkdir ~/.zsh # create a folder to save your completions. it can be anywhere
+deno completions zsh > .zsh/_deno
+```
+
+then add this to your `.zshrc`
+
+```shell
+fpath=(~/.zsh $fpath)
+autoload -Uz compinit
+compinit -u
+```
+
+and restart your terminal. note that if completions are still not loading, you
+may need to run `rm ~/.zcompdump/` to remove previously generated completions
+and then `compinit` to generate them again.
+
+Example (zsh + oh-my-zsh) [recommended for zsh users] :
```shell
mkdir ~/.oh-my-zsh/custom/plugins/deno
deno completions zsh > ~/.oh-my-zsh/custom/plugins/deno/_deno
```
-After this add `deno` plugin under plugins tag in `~/.zshrc` file.
+After this add deno plugin under plugins tag in `~/.zshrc` file. for tools like
+`antigen` path will be `~/.antigen/bundles/robbyrussell/oh-my-zsh/plugins` and
+command will be `antigen bundle deno` and so on.
### Editors and IDEs