Skip to content

vim-plugin.md

Latest commit

 

History

History
158 lines (110 loc) · 4.55 KB

vim-plugin.md

File metadata and controls

158 lines (110 loc) · 4.55 KB

Vim Plugins

Although Vim already provides very powerful features, a few good plugins can make your work even more efficient.

Install Plugins

If you want to install Vim plugins manually, you need to complete the following steps (it is not recommended to install manually, please refer to the Plugin Management content below):

  1. Create the .vim folder
cd ~
mkdir .vim
  1. Create the bundle folder in the .vim folder
cd .vim
mkdir bundle
  1. copy or clone the plugin to the bundle folder
cd bundle
git clone <repository-url>

Note: If the plugin does not have a git address, you can also create the relevant folder directly and place a .vim file in it.

  1. Edit runtimepath

By modifying the runtimepath property, you can let Vim find the plugin you want to load. To view the runtimepath property, you can use the :set runtimepath command

You can enable new plugins by adding the following configuration to .vimrc

set runtimepath^=~/.vim/bundle/<folder>/
" OR
set runtimepath^=~/.vim/bundle/<name>.vim

Plugin Management

When you have more and more plugins, you need a manager to manage Vim plugins. There are several popular plugin managers:

  1. vim-plug
  2. Vundle.vim

I personally prefer vim-plug, and I will briefly introduce this manager below.

vim-plug Introduction

Project Address

https://github.com/junegunn/vim-plug

Install

Download plug.vim, and put it in the autoload folder (usually this folder is located in ~/.vim/autoload/).

Unix

curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

Neovim

curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

Windows（PowerShell）

md ~\vimfiles\autoload
$uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
(New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\vimfiles\autoload\plug.vim"))

Configuration

Add the vim-plug configuration to ~/.vimrc:

  1. The configuration starts with call plug#begin()
  2. Plugin list, starting with the Plug command
  3. End with call plug#end() to initialize the plugin system
  • This will automatically enable filetype plugin indent on and syntax enable. If you don't want this, you can reset your settings after this configuration, for example: filetype indent off, syntax off

Example

" define the location to save plugins
call plug#begin('~/.vim/bundle')

" Note that single quotes should be used

" Some plugin list

" If the plugin's GitHub address is https://github.com/junegunn/vim-easy-align
" Then you can write like this
Plug 'junegunn/vim-easy-align'

" Or directly give the plugin git address
Plug 'https://github.com/junegunn/vim-github-dashboard.git'

" Use `|` to separate multiple `Plug` commands in one line
Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'

" More configuration details can be found on the official website

" Initialize the plugin system
call plug#end()

Restart Vim or reload .vimrc and execute :PlugInstall to install the configured plugin

The reload command is :source ~/.vimrc

Common Commands

Command Description
PlugInstall [name ...] [#threads] Install plugin
PlugUpdate [name ...] [#threads] Install or upgrade
PlugClean Clean plugin
PlugUpgrade Upgrade vim-plug
PlugStatus View installed state

Note: For more commands, see the official website

Where to Find Plugins

  1. There are a lot of Vim plugin resources on GitHub, you can search by vim plug keyword to view all related resources
  2. Vim Scripts Vim official script collection, note that in addition to plugins, there are many Vim scripts inside
  3. Vim Awesome Vim plugin recommendation
  4. This tutorial will also update some excellent plugins and usage instructions from time to time in Plugin Recommendations