spacemacs/layers/+vim/evil-commentary/README.org
justbur 6eab954afe Use + instead of ! for layer categories
Helm seems to treat "!" specially in pattern matching, so having a ! in
the pattern string when traversing directories is problematic. This
change fixes #2737, because as far as I can tell "+" has no special
meaning in a helm pattern.

Of course, we can choose a different character, but I'm fond of "+" as
representing "more layers here".
2015-09-11 00:13:51 -04:00

34 lines
1.3 KiB
Org Mode

#+TITLE: Evil-commentary contribution layer for Spacemacs
* Table of Contents :TOC@4:
- [[#description][Description]]
- [[#install][Install]]
- [[#key-bindings][Key bindings]]
* Description
This layer replaces [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] with [[https://github.com/linktohack/evil-commentary][evil-commentary]] for those
who prefer the behaviour of [[https://github.com/tpope/vim-commentary][vim-commentary]].
- Use ~gcc~ to comment out a line (takes a count),
- ~gc~ to comment out the target of a motion (for example,
- ~gcap~ to comment out a paragraph), ~gc~ in visual
mode to comment out the selection.
For more details see the [[https://github.com/linktohack/evil-commentary][evil-commentary]] repository.
* Install
To use this contribution add it to your =~/.spacemacs=.
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(evil-commentary))
#+END_SRC
* Key bindings
| Key Binding | Description |
|-------------+-------------------------------|
| ~SPC ;~ | comment operator |
| ~gcc~ | comment current line |
| ~gcap~ | comment paragraphs |
| ~gc SPC l~ | comment up to a line with avy |
| ~gy~ | comment and yank |