summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorSandra Parsick <sparsick@users.noreply.github.com>2018-10-05 23:18:10 +0200
committerMarc Cornellà <marc.cornella@live.com>2018-10-05 23:18:10 +0200
commit9aa8af3d0ce726cddf6e0e702abc5bfd90575257 (patch)
tree55d4d92f3404741887e0327ded8a00fcbabf5e65 /plugins
parent9e14387408fd83be63ac5158f4671944ca9bad14 (diff)
downloadzsh-9aa8af3d0ce726cddf6e0e702abc5bfd90575257.tar.gz
zsh-9aa8af3d0ce726cddf6e0e702abc5bfd90575257.tar.bz2
zsh-9aa8af3d0ce726cddf6e0e702abc5bfd90575257.zip
kate: add README (#7238)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/kate/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/kate/README.md b/plugins/kate/README.md
new file mode 100644
index 000000000..aa2eaa3cc
--- /dev/null
+++ b/plugins/kate/README.md
@@ -0,0 +1,20 @@
+# Kate plugin
+
+This plugin adds aliases for the [Kate editor](https://kate-editor.org).
+
+To use it, add kate to the plugins array of your zshrc file:
+```
+plugins=(... kate)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-------|------------------------|---------------------|
+| kate | `kate >/dev/null 2>&1` | Start kate silently |
+
+## Functions
+
+| Function | Description |
+|------------|------------------------------------------|
+| `kt <dir>` | Change to directory and start kate there |