summaryrefslogtreecommitdiff
path: root/plugins/kate/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-24 17:57:01 +0200
committerGitHub <noreply@github.com>2019-10-24 17:57:01 +0200
commitcad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch)
tree2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/kate/README.md
parent225425fe091ca052997833279ccc08643818c24a (diff)
parent40df67bc3b9b51caa24df5d220487043040d1f9a (diff)
downloadzsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/kate/README.md')
-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 |