ylib/nerdcommenter
1
0
Fork 0
mirror of https://github.com/preservim/nerdcommenter.git synced 2024-11-22 13:14:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated readme.

Browse Source
This commit is contained in:
Abel Martin 2012-03-26 12:32:56 -03:00
parent f6a3b192b8
commit 69c5335553
1 changed files with 32 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -1,66 +1,80 @@
h1. Installation
# Installation
The NERD Commenter requires Vim 7 or higher.
Extract the plugin files in your ~/.vim (*nix) or ~/vimfiles (Windows). You
should have 2 files:
plugin/NERD_commenter.vim
doc/NERD_commenter.txt
h1. Usage
Next, to finish installing the help file run:
:helptags ~/.vim/doc
See |add-local-help| for more details.
Make sure that you have filetype plugins enabled, as the script makes use of
|'commentstring'| where possible (which is usually set in a filetype plugin).
See |filetype-plugin-on| for details, but basically, stick this in your vimrc
filetype plugin on
# Usage
The following key mappings are provided by default (there is also a menu
provided that contains menu items corresponding to all the below mappings):
Most of the following mappings are for normal/visual mode only. The
|NERDComInsertComment| mapping is for insert mode only.
Most of the following mappings are for normal/visual mode only. The |NERDComInsertComment| mapping is for insert mode only.
[count]<leader>cc |NERDComComment|
**[count]\<leader\>cc |NERDComComment|**
Comment out the current line or text selected in visual mode.
[count]<leader>cn |NERDComNestedComment|
**[count]<leader>cn |NERDComNestedComment|**
Same as <leader>cc but forces nesting.
[count]<leader>c<space> |NERDComToggleComment|
**[count]<leader>c<space> |NERDComToggleComment|**
Toggles the comment state of the selected line(s). If the topmost selected
line is commented, all selected lines are uncommented and vice versa.
[count]<leader>cm |NERDComMinimalComment|
**[count]<leader>cm |NERDComMinimalComment|**
Comments the given lines using only one set of multipart delimiters.
[count]<leader>ci |NERDComInvertComment|
**[count]<leader>ci |NERDComInvertComment|**
Toggles the comment state of the selected line(s) individually.
[count]<leader>cs |NERDComSexyComment|
**[count]<leader>cs |NERDComSexyComment|**
Comments out the selected lines ``sexily''
[count]<leader>cy |NERDComYankComment|
**[count]<leader>cy |NERDComYankComment|**
Same as <leader>cc except that the commented line(s) are yanked first.
<leader>c$ |NERDComEOLComment|
**<leader>c$ |NERDComEOLComment|**
Comments the current line from the cursor to the end of line.
<leader>cA |NERDComAppendComment|
**<leader>cA |NERDComAppendComment|**
Adds comment delimiters to the end of line and goes into insert mode between
them.
|NERDComInsertComment|
**|NERDComInsertComment|**
Adds comment delimiters at the current cursor position and inserts between.
Disabled by default.
<leader>ca |NERDComAltDelim|
**<leader>ca |NERDComAltDelim|**
Switches to the alternative set of delimiters.
[count]<leader>cl
[count]<leader>cb |NERDComAlignedComment|
**[count]<leader>cl**
**[count]<leader>cb |NERDComAlignedComment|**
Same as |NERDComComment| except that the delimiters are aligned down the
left side (<leader>cl) or both sides (<leader>cb).
[count]<leader>cu |NERDComUncommentLine|
**[count]<leader>cu |NERDComUncommentLine|**
Uncomments the selected line(s).