From 56de7c85f34a15a4490f4984e128dba78fcebfd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Malard?= Date: Tue, 28 Dec 2021 17:06:50 +0100 Subject: [PATCH] docs(aliases): clarify usage (#9990) --- plugins/aliases/README.md | 21 +++++++++++---------- 1 file 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 `: filter aliases by `` and highlight. + + ![screenshot](https://cloud.githubusercontent.com/assets/3602957/11581913/cb54fb8a-9a82-11e5-846b-5a67f67ad9ad.png)