diff options
| author | Cédric Malard <c.malard-git@valdun.net> | 2021-12-28 17:06:50 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-28 17:06:50 +0100 |
| commit | 56de7c85f34a15a4490f4984e128dba78fcebfd3 (patch) | |
| tree | abe36113b4ad7e15e321047398318252fd03bb41 | |
| parent | d5cb1d339f3fb8b181d5ab5527718657587021ea (diff) | |
| download | zsh-56de7c85f34a15a4490f4984e128dba78fcebfd3.tar.gz zsh-56de7c85f34a15a4490f4984e128dba78fcebfd3.tar.bz2 zsh-56de7c85f34a15a4490f4984e128dba78fcebfd3.zip | |
docs(aliases): clarify usage (#9990)
| -rw-r--r-- | plugins/aliases/README.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/plugins/aliases/README.md b/plugins/aliases/README.md index 481c1bd4e..bfb6ab8c4 100644 --- a/plugins/aliases/README.md +++ b/plugins/aliases/README.md @@ -1,21 +1,22 @@ -## Aliases Cheatsheet +# Aliases cheatsheet **Maintainer:** [@hqingyi](https://github.com/hqingyi) With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts that are currently available based on the plugins you have enabled. -Enable this plugin by adding it to your `plugins` definition in `~/.zshrc`. +To use it, add `aliases` to the plugins array in your zshrc file: - ``` - plugins=(aliases) - ``` +```zsh +plugins=(aliases) +``` Requirements: Python needs to be installed. -### Usage +## Usage -``` - acs: group all alias - acs $keywordquickly filter alias & highlight -``` +- `acs`: show all aliases by group. + +- `acs <keyword>`: filter aliases by `<keyword>` and highlight. + +  |