m-vim_plugins/nerdcommenter
1
0
Fork 0
mirror of https://github.com/preservim/nerdcommenter.git synced 2025-11-10 10:43:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

adding better styling to the readme.

Browse Source
This commit is contained in:
Abel Martin
2012-03-26 11:36:43 -04:00
parent 69c5335553
commit 73b3fe939c
1 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@@ -3,18 +3,18 @@ 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
1. plugin/NERD_commenter.vim
2. doc/NERD_commenter.txt
Next, to finish installing the help file run:
:helptags ~/.vim/doc
* :helptags ~/.vim/doc
See |add-local-help| for more details.
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
**|'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
@@ -27,36 +27,36 @@ Most of the following mappings are for normal/visual mode only. The |NERDComInse
Comment out the current line or text selected in visual mode.
**[count]<leader>cn |NERDComNestedComment|**
Same as <leader>cc but forces nesting.
**[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|**
Same as <leader>cc except that the commented line(s) are yanked first.
**[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.
@@ -66,15 +66,15 @@ 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).
left side (\<leader\>cl) or both sides (\<leader\>cb).
**[count]<leader>cu |NERDComUncommentLine|**
**[count]\<leader\>cu |NERDComUncommentLine|**
Uncomments the selected line(s).