This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+vim/evil-commentary/README.org
Eivind Fonn c3866382b2 Documentation update
- Add #+HTML_HEAD_EXTRA options to all org files
- HTMLize published documentation via CSS
2015-11-13 14:23:13 +01:00

34 lines
1.4 KiB
Org Mode

#+TITLE: Evil-commentary contribution layer for Spacemacs
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="../../../css/readtheorg.css" />
* Table of Contents :TOC_4_org:noexport:
- [[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 y~ | comment up to a line with avy |
| ~gy~ | comment and yank |