From 73b3fe939c57c79f1eb12d24bdf97e8b49347675 Mon Sep 17 00:00:00 2001 From: Abel Martin Date: Mon, 26 Mar 2012 11:36:43 -0400 Subject: [PATCH] adding better styling to the readme. --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7776883..69bc3c5 100644 --- a/README.md +++ b/README.md @@ -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]cn |NERDComNestedComment|** -Same as cc but forces nesting. +**[count]\cn |NERDComNestedComment|** +Same as \cc but forces nesting. -**[count]c |NERDComToggleComment|** +**[count]\c |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]cm |NERDComMinimalComment|** +**[count]\cm |NERDComMinimalComment|** Comments the given lines using only one set of multipart delimiters. -**[count]ci |NERDComInvertComment|** +**[count]\ci |NERDComInvertComment|** Toggles the comment state of the selected line(s) individually. -**[count]cs |NERDComSexyComment|** +**[count]\cs |NERDComSexyComment|** Comments out the selected lines ``sexily'' -**[count]cy |NERDComYankComment|** -Same as cc except that the commented line(s) are yanked first. +**[count]\cy |NERDComYankComment|** +Same as \cc except that the commented line(s) are yanked first. -**c$ |NERDComEOLComment|** +**\c$ |NERDComEOLComment|** Comments the current line from the cursor to the end of line. -**cA |NERDComAppendComment|** +**\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. -**ca |NERDComAltDelim|** +**\ca |NERDComAltDelim|** Switches to the alternative set of delimiters. -**[count]cl** -**[count]cb |NERDComAlignedComment|** +**[count]\cl** +**[count]\cb |NERDComAlignedComment|** Same as |NERDComComment| except that the delimiters are aligned down the -left side (cl) or both sides (cb). +left side (\cl) or both sides (\cb). -**[count]cu |NERDComUncommentLine|** +**[count]\cu |NERDComUncommentLine|** Uncomments the selected line(s).