mirror of
https://github.com/preservim/nerdcommenter.git
synced 2025-11-15 13:13:47 -05:00
Wrap installation blurbs in expandable summary/detail blocks
This commit is contained in:
committed by
Caleb Maclennan
parent
6d0ab7dec9
commit
d4855b233e
26
README.md
26
README.md
@@ -8,33 +8,55 @@ Comment functions so powerful—no comment necessary.
|
|||||||
|
|
||||||
### Via Plugin Manager (Recommended)
|
### Via Plugin Manager (Recommended)
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Vim Plug</summary>
|
||||||
|
|
||||||
#### [Vim-Plug](https://github.com/junegunn/vim-plug)
|
#### [Vim-Plug](https://github.com/junegunn/vim-plug)
|
||||||
|
|
||||||
1. Add `Plug 'preservim/nerdcommenter'` to your vimrc file.
|
1. Add `Plug 'preservim/nerdcommenter'` to your vimrc file.
|
||||||
2. Reload your vimrc or restart
|
2. Reload your vimrc or restart
|
||||||
3. Run `:PlugInstall`
|
3. Run `:PlugInstall`
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Vundle</summary>
|
||||||
|
|
||||||
#### [Vundle](https://github.com/VundleVim/Vundle.vim) or similar
|
#### [Vundle](https://github.com/VundleVim/Vundle.vim) or similar
|
||||||
|
|
||||||
1. Add `Plugin 'preservim/nerdcommenter'` to your vimrc file.
|
1. Add `Plugin 'preservim/nerdcommenter'` to your vimrc file.
|
||||||
2. Reload your vimrc or restart
|
2. Reload your vimrc or restart
|
||||||
3. Run `:BundleInstall`
|
3. Run `:BundleInstall`
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>NeoBundle</summary>
|
||||||
|
|
||||||
#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
|
#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
|
||||||
|
|
||||||
1. Add `NeoBundle 'preservim/nerdcommenter'` to your vimrc file.
|
1. Add `NeoBundle 'preservim/nerdcommenter'` to your vimrc file.
|
||||||
2. Reload your vimrc or restart
|
2. Reload your vimrc or restart
|
||||||
3. Run `:NeoUpdate`
|
3. Run `:NeoUpdate`
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Pathogen</summary>
|
||||||
|
|
||||||
#### [Pathogen](https://github.com/tpope/vim-pathogen)
|
#### [Pathogen](https://github.com/tpope/vim-pathogen)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
cd ~/.vim/bundle
|
cd ~/.vim/bundle
|
||||||
git clone https://github.com/preservim/nerdcommenter.git
|
git clone https://github.com/preservim/nerdcommenter.git
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
### Manual Installation
|
### Manual Installation
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Unix</summary>
|
||||||
|
|
||||||
#### Unix
|
#### Unix
|
||||||
|
|
||||||
(For Neovim, change `~/.vim/` to `~/.config/nvim/`.)
|
(For Neovim, change `~/.vim/` to `~/.config/nvim/`.)
|
||||||
@@ -45,7 +67,10 @@ curl -fLo ~/.vim/plugin/NERD_Commenter.vim --create-dirs \
|
|||||||
curl -fLo ~/.vim/doc/NERD_Commenter.txt --create-dirs \
|
curl -fLo ~/.vim/doc/NERD_Commenter.txt --create-dirs \
|
||||||
https://raw.githubusercontent.com/preservim/nerdcommenter/master/doc/NERD_commenter.txt
|
https://raw.githubusercontent.com/preservim/nerdcommenter/master/doc/NERD_commenter.txt
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Windows</summary>
|
||||||
#### Windows (PowerShell)
|
#### Windows (PowerShell)
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
@@ -56,6 +81,7 @@ $docsuri = 'https://raw.githubusercontent.com/preservim/nerdcommenter/master/doc
|
|||||||
(New-Object Net.WebClient).DownloadFile($pluguri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\plugin\NERD_commenter.vim"))
|
(New-Object Net.WebClient).DownloadFile($pluguri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\plugin\NERD_commenter.vim"))
|
||||||
(New-Object Net.WebClient).DownloadFile($docsuri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\doc\NERD_commenter.txt"))
|
(New-Object Net.WebClient).DownloadFile($docsuri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\doc\NERD_commenter.txt"))
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
### Post Installation
|
### Post Installation
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user