add vim-leader

[webi-installers/.git] / vim-leader / README.md

diff --git a/vim-leader/README.md b/vim-leader/README.md
new file mode 100644 (file)
index 0000000..fc45b46
--- /dev/null
+++ b/vim-leader/README.md
@@ -0,0 +1,31 @@
+---
+title: vim-leader
+homepage: https://webinstall.dev/vim-leader
+tagline: |
+  vim leader maps Space as Leader, keep Backslash and Comma as aliases
+---
+
+To update (replacing the current version) run `webi vim-leader`.
+
+## Cheat Sheet
+
+> `let mapleader = " "`
+
+The `<Leader>` key is typically used for your own custom shortcuts.
+
+By default it's mapped to `\` (backslash) - a legacy from a time when `\` was in
+a more accessible place - but most people remap it to `,` or ` ` (space).
+
+This vim-leader plugin makes Space the Leader key, but also remaps `\` and `,`
+as aliases.
+
+### How to configure manually
+
+The Leader key **_MUST_** be defined before any mappings that use it (probably
+before any plugins) - pretty the first thing in your `~/.vimrc`.
+
+```vim
+let mapleader = ' '
+nmap <bslash> <space>
+nmap , <space>
+```