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

Overhaul installation instructions

Browse Source 
See discussion in #241
This commit is contained in:
Caleb Maclennan 2016-05-24 19:39:07 +03:00
parent d59f0b614f
commit 9e8410e1b9
No known key found for this signature in database
GPG Key ID: 63CC496475267693
1 changed files with 75 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
README.md
View File

@ -1,130 +1,113 @@
# Installation
The NERD Commenter requires Vim 7 or higher is comprised of 2 files:
plugin/NERD_commenter.vim
doc/NERD_commenter.txt
# Installation
## Via Plugin Manager (Recommended)
#### Pathogen Install
### [Vim-Plug](https://github.com/junegunn/vim-plug)
###### Unix
```sh
git clone https://github.com/scrooloose/nerdcommenter.git ~/.vim/bundle
```
###### Neovim
```sh
git clone https://github.com/scrooloose/nerdcommenter.git ~/.config/nvim/bundle
```
#### Vim-Plug Install
1. Add `Plug 'Plug scrooloose/nerdcommenter'` to your .vimrc file.
2. Reload .vimrc (`:so %` from vimrc, or just restart vim)
1. Add `Plug 'Plug scrooloose/nerdcommenter'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:PlugInstall`
#### Vundle Install
1. Add `Plugin 'scrooloose/nerdcommenter'` to your .vimrc file.
2. Run `:BundleInstall`
### [Vundle](https://github.com/VundleVim/Vundle.vim) or similar
#### NeoBundle Install
1. Add `NeoBundle 'scrooloose/nerdcommenter'` to your .vimrc file.
2. Run `:NeoUpdate``
1. Add `Plugin 'scrooloose/nerdcommenter'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:BundleInstall`
#### Post Install
After the **'Classic'** or **'Pathogen'** install, 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:
### [NeoBundle](https://github.com/Shougo/neobundle.vim)
filetype plugin on
1. Add `NeoBundle 'scrooloose/nerdcommenter'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:NeoUpdate``
## Install Manually
#### Vim
###### Unix
### [Pathogen](https://github.com/tpope/vim-pathogen)
```sh
git clone https://github.com/scrooloose/nerdcommenter.git ~/.vim/plugin
cd ~/.vim/bundle
git clone https://github.com/scrooloose/nerdcommenter.git
```
###### Windows (PowerShell)
## Manual Installation
### Unix
(For Neovim, change `~/.vim/` to `~/.config/nvim/`.)
```sh
curl -fLo ~/.vim/plugin/NERD_Commenter.vim --create-dirs \
https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim
curl -fLo ~/.vim/doc/NERD_Commenter.txt --create-dirs \
https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/doc/NERD_commenter.txt
```
### Windows (PowerShell)
```powershell
md ~\vimfiles\plugin
$uri = 'https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim'
(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\autoload\NERD_commenter.vim"))
md ~\vimfiles\doc
$pluguri = 'https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/plugin/NERD_commenter.vim'
$docsuri = 'https://raw.githubusercontent.com/scrooloose/nerdcommenter/master/doc/NERD_commenter.txt'
(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\plugin\NERD_commenter.vim"))
(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\doc\NERD_commenter.txt"))
```
#### Neovim
## Post Installation
Make sure that you have filetype plugins enabled, as the plugin makes use of
**|commentstring|** where possible (which is usually set in a filetype plugin).
See **|filetype-plugin-on|** for details, but the short version is make sure this line appears in your vimrc:
```sh
git clone https://github.com/scrooloose/nerdcommenter.git ~/.config/nvim/plugin
filetype plugin on
```
# Usage
# 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):
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|**
Comment out the current line or text selected in visual mode.
**[count]\<leader\>cc |NERDComComment|**
Comment out the current line or text selected in visual mode.
**[count]\<leader\>cn |NERDComNestedComment|**
Same as \<leader\>cc but forces nesting.
**[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\>cn |NERDComNestedComment|**
Same as \<leader\>cc but forces nesting.
**[count]\<leader\>cm |NERDComMinimalComment|**
Comments the given lines using only one set of multipart delimiters.
**[count]\<leader\>ci |NERDComInvertComment|**
Toggles the comment state of the selected line(s) individually.
**[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\>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\>cm |NERDComMinimalComment|**
Comments the given lines using only one set of multipart delimiters.
**\<leader\>c$ |NERDComEOLComment|**
Comments the current line from the cursor to the end of line.
**\<leader\>cA |NERDComAppendComment|**
Adds comment delimiters to the end of line and goes into insert mode between
them.
**[count]\<leader\>ci |NERDComInvertComment|**
Toggles the comment state of the selected line(s) individually.
**|NERDComInsertComment|**
Adds comment delimiters at the current cursor position and inserts between.
Disabled by default.
**\<leader\>ca |NERDComAltDelim|**
Switches to the alternative set of delimiters.
**[count]\<leader\>cs |NERDComSexyComment|**
Comments out the selected lines ``sexily''
**[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\>cy |NERDComYankComment|**
Same as \<leader\>cc except that the commented line(s) are yanked first.
**\<leader\>c$ |NERDComEOLComment|**
Comments the current line from the cursor to the end of line.
**\<leader\>cA |NERDComAppendComment|**
Adds comment delimiters to the end of line and goes into insert mode between
them.
**|NERDComInsertComment|**
Adds comment delimiters at the current cursor position and inserts between.
Disabled by default.
**\<leader\>ca |NERDComAltDelim|**
Switches to the alternative set of delimiters.
**[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|**
Uncomments the selected line(s).
**[count]\<leader\>cu |NERDComUncommentLine|**
Uncomments the selected line(s).