Update examples

junegunn · Mar 14, 2024 · 61b6df6 · 61b6df6
1 parent 94b7aa9
commit 61b6df6
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -133,31 +133,36 @@ call plug#begin()
 
 " Make sure you use single quotes
 
-" Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
+" Shorthand notation for GitHub; translates to https://github.com/junegunn/vim-easy-align
 Plug 'junegunn/vim-easy-align'
 
 " Any valid git URL is allowed
-Plug 'https://github.com/junegunn/vim-github-dashboard.git'
-
-" Multiple Plug commands can be written in a single line using | separators
-Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
-
-" On-demand loading
-Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
-Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
-
-" Using a non-default branch
-Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
+Plug 'https://github.com/junegunn/seoul256.vim.git'
 
 " Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
 Plug 'fatih/vim-go', { 'tag': '*' }
 
-" Plugin options
-Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
+" Using a non-default branch
+Plug 'neoclide/coc.nvim', { 'branch': 'release' }
+
+" Use 'dir' option to install plugin in a non-default directory
+Plug 'junegunn/fzf', { 'dir': '~/.fzf' }
 
-" Plugin outside ~/.vim/plugged with post-update hook
+" Post-update hook: run a shell command after installing or updating the plugin
 Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
 
+" Post-update hook can be a lambda expression
+Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
+
+" If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+Plug 'nsf/gocode', { 'rtp': 'vim' }
+
+" On-demand loading: loaded when the specified command is executed
+Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
+
+" On-demand loading: loaded when a file with a specific file type is opened
+Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
+
 " Unmanaged plugin (manually installed and updated)
 Plug '~/my-prototype-plugin'
 
@@ -181,31 +186,38 @@ local Plug = vim.fn['plug#']
 
 vim.call('plug#begin')
 
--- Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
+-- Shorthand notation for GitHub; translates to https://github.com/junegunn/vim-easy-align
 Plug('junegunn/vim-easy-align')
 
 -- Any valid git URL is allowed
-Plug('https://github.com/junegunn/vim-github-dashboard.git')
-
--- Multiple Plug commands can be written in a single line using ; separators
-Plug('SirVer/ultisnips'); Plug('honza/vim-snippets')
-
--- On-demand loading
-Plug('preservim/nerdtree', { ['on'] = 'NERDTreeToggle' })
-Plug('tpope/vim-fireplace', { ['for'] = 'clojure' })
-
--- Using a non-default branch
-Plug('rdnetto/YCM-Generator', { ['branch'] = 'stable' })
+Plug('https://github.com/junegunn/seoul256.vim.git')
 
 -- Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
 Plug('fatih/vim-go', { ['tag'] = '*' })
 
--- Plugin options
-Plug('nsf/gocode', { ['tag'] = 'v.20150303', ['rtp'] = 'vim' })
+-- Using a non-default branch
+Plug('neoclide/coc.nvim', { ['branch'] = 'release' })
+
+-- Use 'dir' option to install plugin in a non-default directory
+Plug('junegunn/fzf', { ['dir'] = '~/.fzf' })
 
--- Plugin outside ~/.vim/plugged with post-update hook
+-- Post-update hook: run a shell command after installing or updating the plugin
 Plug('junegunn/fzf', { ['dir'] = '~/.fzf', ['do'] = './install --all' })
 
+-- Post-update hook can be a lambda expression
+Plug('junegunn/fzf', { ['do'] = function()
+  vim.fn['fzf#install']()
+end })
+
+-- If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+Plug('nsf/gocode', { ['rtp'] = 'vim' })
+
+-- On-demand loading: loaded when the specified command is executed
+Plug('preservim/nerdtree', { ['on'] = 'NERDTreeToggle' })
+
+-- On-demand loading: loaded when a file with a specific file type is opened
+Plug('tpope/vim-fireplace', { ['for'] = 'clojure' })
+
 -- Unmanaged plugin (manually installed and updated)
 Plug('~/my-prototype-plugin')
 

diff --git a/doc/plug.txt b/doc/plug.txt
@@ -1,4 +1,4 @@
-plug.txt	plug	Last change: March 7 2024
+plug.txt	plug	Last change: March 14 2024
 PLUG - TABLE OF CONTENTS                                         *plug* *plug-toc*
 ==============================================================================
 
@@ -69,31 +69,36 @@ Example~
 
     " Make sure you use single quotes
 
-    " Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
+    " Shorthand notation for GitHub; translates to https://github.com/junegunn/vim-easy-align
     Plug 'junegunn/vim-easy-align'
 
     " Any valid git URL is allowed
-    Plug 'https://github.com/junegunn/vim-github-dashboard.git'
-
-    " Multiple Plug commands can be written in a single line using | separators
-    Plug 'SirVer/ultisnips' | Plug 'honza/vim-snippets'
-
-    " On-demand loading
-    Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
-    Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
-
-    " Using a non-default branch
-    Plug 'rdnetto/YCM-Generator', { 'branch': 'stable' }
+    Plug 'https://github.com/junegunn/seoul256.vim.git'
 
     " Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
     Plug 'fatih/vim-go', { 'tag': '*' }
 
-    " Plugin options
-    Plug 'nsf/gocode', { 'tag': 'v.20150303', 'rtp': 'vim' }
+    " Using a non-default branch
+    Plug 'neoclide/coc.nvim', { 'branch': 'release' }
+
+    " Use 'dir' option to install plugin in a non-default directory
+    Plug 'junegunn/fzf', { 'dir': '~/.fzf' }
 
-    " Plugin outside ~/.vim/plugged with post-update hook
+    " Post-update hook: run a shell command after installing or updating the plugin
     Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
 
+    " Post-update hook can be a lambda expression
+    Plug 'junegunn/fzf', { 'do': { -> fzf#install() } }
+
+    " If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+    Plug 'nsf/gocode', { 'rtp': 'vim' }
+
+    " On-demand loading: loaded when the specified command is executed
+    Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
+
+    " On-demand loading: loaded when a file with a specific file type is opened
+    Plug 'tpope/vim-fireplace', { 'for': 'clojure' }
+
     " Unmanaged plugin (manually installed and updated)
     Plug '~/my-prototype-plugin'
 
@@ -117,31 +122,38 @@ example above.
 
     vim.call('plug#begin')
 
-    -- Shorthand notation; fetches https://github.com/junegunn/vim-easy-align
+    -- Shorthand notation for GitHub; translates to https://github.com/junegunn/vim-easy-align
     Plug('junegunn/vim-easy-align')
 
     -- Any valid git URL is allowed
-    Plug('https://github.com/junegunn/vim-github-dashboard.git')
-
-    -- Multiple Plug commands can be written in a single line using ; separators
-    Plug('SirVer/ultisnips'); Plug('honza/vim-snippets')
-
-    -- On-demand loading
-    Plug('preservim/nerdtree', { ['on'] = 'NERDTreeToggle' })
-    Plug('tpope/vim-fireplace', { ['for'] = 'clojure' })
-
-    -- Using a non-default branch
-    Plug('rdnetto/YCM-Generator', { ['branch'] = 'stable' })
+    Plug('https://github.com/junegunn/seoul256.vim.git')
 
     -- Using a tagged release; wildcard allowed (requires git 1.9.2 or above)
     Plug('fatih/vim-go', { ['tag'] = '*' })
 
-    -- Plugin options
-    Plug('nsf/gocode', { ['tag'] = 'v.20150303', ['rtp'] = 'vim' })
+    -- Using a non-default branch
+    Plug('neoclide/coc.nvim', { ['branch'] = 'release' })
+
+    -- Use 'dir' option to install plugin in a non-default directory
+    Plug('junegunn/fzf', { ['dir'] = '~/.fzf' })
 
-    -- Plugin outside ~/.vim/plugged with post-update hook
+    -- Post-update hook: run a shell command after installing or updating the plugin
     Plug('junegunn/fzf', { ['dir'] = '~/.fzf', ['do'] = './install --all' })
 
+    -- Post-update hook can be a lambda expression
+    Plug('junegunn/fzf', { ['do'] = function()
+      vim.fn['fzf#install']()
+    end })
+
+    -- If the vim plugin is in a subdirectory, use 'rtp' option to specify its path
+    Plug('nsf/gocode', { ['rtp'] = 'vim' })
+
+    -- On-demand loading: loaded when the specified command is executed
+    Plug('preservim/nerdtree', { ['on'] = 'NERDTreeToggle' })
+
+    -- On-demand loading: loaded when a file with a specific file type is opened
+    Plug('tpope/vim-fireplace', { ['for'] = 'clojure' })
+
     -- Unmanaged plugin (manually installed and updated)
     Plug('~/my-prototype-plugin')