kevin/vim-plug
1
Fork 0
mirror of https://github.com/junegunn/vim-plug.git synced 2024-12-19 10:35:38 -07:00
Code Issues Packages Projects Releases Wiki Activity

Adjust heading levels in README

Browse Source
This commit is contained in:
Junegunn Choi 2024-05-15 03:07:01 +09:00
parent 9b4ecd1bb5
commit 3f1daea5bd
No known key found for this signature in database
GPG Key ID: 254BC280FEF9C627
2 changed files with 75 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -30,7 +30,7 @@ A minimalist Vim plugin manager.
<img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450"> <img src="https://raw.githubusercontent.com/junegunn/i/master/vim-plug/installer.gif" height="450">
### Pros. ## Pros.
- Minimalist design - Minimalist design
- Just one file with no dependencies. Super easy to set up. - Just one file with no dependencies. Super easy to set up.
@ -49,7 +49,7 @@ A minimalist Vim plugin manager.
[40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif [40/4]: https://raw.githubusercontent.com/junegunn/i/master/vim-plug/40-in-4.gif
[startup-time]: https://github.com/junegunn/vim-startuptime-benchmark#result [startup-time]: https://github.com/junegunn/vim-startuptime-benchmark#result
### Installation ## Installation
[Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim) [Download plug.vim](https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim)
and put it in the "autoload" directory. and put it in the "autoload" directory.
@ -57,9 +57,9 @@ and put it in the "autoload" directory.
<details> <details>
<summary>Click to see the instructions</summary> <summary>Click to see the instructions</summary>
#### Vim ### Vim
###### Unix #### Unix
```sh ```sh
curl -fLo ~/.vim/autoload/plug.vim --create-dirs \ curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
@ -71,30 +71,30 @@ file as suggested [here][auto].
[auto]: https://github.com/junegunn/vim-plug/wiki/tips#automatic-installation [auto]: https://github.com/junegunn/vim-plug/wiki/tips#automatic-installation
###### Windows (PowerShell) #### Windows (PowerShell)
```powershell ```powershell
iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |` iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
ni $HOME/vimfiles/autoload/plug.vim -Force ni $HOME/vimfiles/autoload/plug.vim -Force
``` ```
#### Neovim ### Neovim
###### Unix, Linux #### Unix, Linux
```sh ```sh
sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \ sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim' https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
``` ```
###### Linux (Flatpak) #### Linux (Flatpak)
```sh ```sh
curl -fLo ~/.var/app/io.neovim.nvim/data/nvim/site/autoload/plug.vim --create-dirs \ curl -fLo ~/.var/app/io.neovim.nvim/data/nvim/site/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
``` ```
###### Windows (PowerShell) #### Windows (PowerShell)
```powershell ```powershell
iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |` iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
@ -103,7 +103,7 @@ iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |`
</details> </details>
### Usage ## Usage
Add a vim-plug section to your `~/.vimrc` (or `init.vim` for Neovim) Add a vim-plug section to your `~/.vimrc` (or `init.vim` for Neovim)
@ -133,7 +133,7 @@ Reload the file or restart Vim, then you can,
> document is for advanced users who want to know more about the features and > document is for advanced users who want to know more about the features and
> options. > options.
#### Getting Help ### Getting Help
- See [tutorial] page to learn more about the basics of vim-plug - See [tutorial] page to learn more about the basics of vim-plug
- See [tips] and [FAQ] pages for common problems and questions - See [tips] and [FAQ] pages for common problems and questions
@ -142,11 +142,11 @@ Reload the file or restart Vim, then you can,
[tips]: https://github.com/junegunn/vim-plug/wiki/tips [tips]: https://github.com/junegunn/vim-plug/wiki/tips
[FAQ]: https://github.com/junegunn/vim-plug/wiki/faq [FAQ]: https://github.com/junegunn/vim-plug/wiki/faq
### More examples ## Examples
The following examples demonstrate the additional features of vim-plug. The following examples demonstrate the additional features of vim-plug.
#### Vim script example ### Vim script example
```vim ```vim
call plug#begin() call plug#begin()
@ -201,7 +201,7 @@ call plug#end()
" syntax off " Disable syntax highlighting " syntax off " Disable syntax highlighting
``` ```
#### Lua configuration example for Neovim ### Lua example for Neovim
In Neovim, you can write your configuration in a Lua script file named In Neovim, you can write your configuration in a Lua script file named
`init.lua`. The following code is the Lua script equivalent to the Vim script `init.lua`. The following code is the Lua script equivalent to the Vim script
@ -251,11 +251,7 @@ Plug('~/my-prototype-plugin')
vim.call('plug#end') vim.call('plug#end')
``` ```
More examples can be found in: ## Commands
* https://gitlab.com/sultanahamer/dotfiles/-/blob/master/nvim/lua/plugins.lua?ref_type=heads
### Commands
| Command | Description | | Command | Description |
| ----------------------------------- | ------------------------------------------------------------------ | | ----------------------------------- | ------------------------------------------------------------------ |
@ -267,7 +263,7 @@ More examples can be found in:
| `PlugDiff` | Examine changes from the previous update and the pending changes | | `PlugDiff` | Examine changes from the previous update and the pending changes |
| `PlugSnapshot[!] [output path]` | Generate script for restoring the current snapshot of the plugins | | `PlugSnapshot[!] [output path]` | Generate script for restoring the current snapshot of the plugins |
### `Plug` options ## `Plug` options
| Option | Description | | Option | Description |
| ----------------------- | ----------------------------------------------------------- | | ----------------------- | ----------------------------------------------------------- |
@ -280,7 +276,7 @@ More examples can be found in:
| `for` | On-demand loading: File types | | `for` | On-demand loading: File types |
| `frozen` | Do not remove and do not update unless explicitly specified | | `frozen` | Do not remove and do not update unless explicitly specified |
### Global options ## Global options
| Flag | Default | Description | | Flag | Default | Description |
| ------------------- | --------------------------------- | ------------------------------------------------------ | | ------------------- | --------------------------------- | ------------------------------------------------------ |
@ -293,7 +289,7 @@ More examples can be found in:
| `g:plug_url_format` | `https://git::@github.com/%s.git` | `printf` format to build repo URL (Only applies to the subsequent `Plug` commands) | | `g:plug_url_format` | `https://git::@github.com/%s.git` | `printf` format to build repo URL (Only applies to the subsequent `Plug` commands) |
### Keybindings ## Keybindings
- `D` - `PlugDiff` - `D` - `PlugDiff`
- `S` - `PlugStatus` - `S` - `PlugStatus`
@ -305,7 +301,7 @@ More examples can be found in:
- `:PlugDiff` - `:PlugDiff`
- `X` - Revert the update - `X` - Revert the update
### Post-update hooks ## Post-update hooks
There are some plugins that require extra steps after installation or update. There are some plugins that require extra steps after installation or update.
In that case, use the `do` option to describe the task to be performed. In that case, use the `do` option to describe the task to be performed.
@ -365,7 +361,7 @@ with the bang-versions of the commands: `PlugInstall!` and `PlugUpdate!`.
> Plug 'junegunn/fzf', { 'do': g:fzf_install } > Plug 'junegunn/fzf', { 'do': g:fzf_install }
> ``` > ```
#### `PlugInstall!` and `PlugUpdate!` ### `PlugInstall!` and `PlugUpdate!`
The installer takes the following steps when installing/updating a plugin: The installer takes the following steps when installing/updating a plugin:
@ -377,7 +373,7 @@ The installer takes the following steps when installing/updating a plugin:
The commands with the `!` suffix ensure that all steps are run unconditionally. The commands with the `!` suffix ensure that all steps are run unconditionally.
### On-demand loading of plugins ## On-demand loading of plugins
```vim ```vim
" NERD tree will be loaded on the first invocation of NERDTreeToggle command " NERD tree will be loaded on the first invocation of NERDTreeToggle command
@ -437,11 +433,11 @@ autocmd! User goyo.vim echom 'Goyo is now loaded!'
> See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually > See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
### Collaborators ## Collaborators
- [Jan Edmund Lazo](https://github.com/janlazo) - Windows support - [Jan Edmund Lazo](https://github.com/janlazo) - Windows support
- [Jeremy Pallats](https://github.com/starcraftman) - Python installer - [Jeremy Pallats](https://github.com/starcraftman) - Python installer
### License ## License
MIT MIT

111
doc/plug.txt
View File

@ -1,24 +1,24 @@
plug.txt plug Last change: May 14 2024 plug.txt plug Last change: May 15 2024
PLUG - TABLE OF CONTENTS *plug* *plug-toc* PLUG - TABLE OF CONTENTS *plug* *plug-toc*
============================================================================== ==============================================================================
vim-plug |vim-plug| vim-plug |vim-plug|
Pros. |plug-pros| Pros. |plug-pros|
Installation |plug-installation| Installation |plug-installation|
Usage |plug-usage| Usage |plug-usage|
Getting Help |plug-getting-help| Getting Help |plug-getting-help|
More examples |plug-more-examples| Examples |plug-examples|
Vim script example |plug-vim-script-example| Vim script example |plug-vim-script-example|
Lua configuration example for Neovim |plug-lua-configuration-example-for-neovim| Lua example for Neovim |plug-lua-example-for-neovim|
Commands |plug-commands| Commands |plug-commands|
Plug options |plug-options| Plug options |plug-options|
Global options |plug-global-options| Global options |plug-global-options|
Keybindings |plug-keybindings| Keybindings |plug-keybindings|
Post-update hooks |plug-post-update-hooks| Post-update hooks |plug-post-update-hooks|
PlugInstall! and PlugUpdate! |pluginstall-and-plugupdate| PlugInstall! and PlugUpdate! |pluginstall-and-plugupdate|
On-demand loading of plugins |plug-on-demand-loading-of-plugins| On-demand loading of plugins |plug-on-demand-loading-of-plugins|
Collaborators |plug-collaborators| Collaborators |plug-collaborators|
License |plug-license| License |plug-license|
VIM-PLUG *vim-plug* VIM-PLUG *vim-plug*
============================================================================== ==============================================================================
@ -26,8 +26,8 @@ VIM-PLUG *vim-plug*
A minimalist Vim plugin manager. A minimalist Vim plugin manager.
< Pros. >_____________________________________________________________________~ PROS. *plug-pros*
*plug-pros* ==============================================================================
- Minimalist design - Minimalist design
- Just one file with no dependencies. Super easy to set up. - Just one file with no dependencies. Super easy to set up.
@ -35,8 +35,8 @@ A minimalist Vim plugin manager.
boilerplate code required. boilerplate code required.
- No feature bloat - No feature bloat
- Extremely stable with flawless backward compatibility - Extremely stable with flawless backward compatibility
- Works perfectly with Vim 7.0+ since 2006 and with all versions of Neovim - Works perfectly with all versions of Vim since 2006 and all versions of
since 2014 Neovim ever released
- {Super-fast}{1} parallel installation/update - {Super-fast}{1} parallel installation/update
- Creates shallow clones to minimize disk space usage and download time - Creates shallow clones to minimize disk space usage and download time
- On-demand loading for {faster startup time}{2} - On-demand loading for {faster startup time}{2}
@ -49,16 +49,16 @@ A minimalist Vim plugin manager.
{2} https://github.com/junegunn/vim-startuptime-benchmark#result {2} https://github.com/junegunn/vim-startuptime-benchmark#result
< Installation >______________________________________________________________~ INSTALLATION *plug-installation*
*plug-installation* ==============================================================================
{Download plug.vim}{3} and put it in the "autoload" directory. {Download plug.vim}{3} and put it in the "autoload" directory.
{3} https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim {3} https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim
< Usage >_____________________________________________________________________~ USAGE *plug-usage*
*plug-usage* ==============================================================================
Add a vim-plug section to your `~/.vimrc` (or `init.vim` for Neovim) Add a vim-plug section to your `~/.vimrc` (or `init.vim` for Neovim)
@ -90,7 +90,7 @@ document is for advanced users who want to know more about the features and
options. options.
Getting Help~ < Getting Help >______________________________________________________________~
*plug-getting-help* *plug-getting-help*
- See {tutorial}{4} page to learn more about the basics of vim-plug - See {tutorial}{4} page to learn more about the basics of vim-plug
@ -101,13 +101,13 @@ Getting Help~
{6} https://github.com/junegunn/vim-plug/wiki/faq {6} https://github.com/junegunn/vim-plug/wiki/faq
< More examples >_____________________________________________________________~ EXAMPLES *plug-examples*
*plug-more-examples* ==============================================================================
The following examples demonstrate the additional features of vim-plug. The following examples demonstrate the additional features of vim-plug.
Vim script example~ < Vim script example >________________________________________________________~
*plug-vim-script-example* *plug-vim-script-example*
> >
call plug#begin() call plug#begin()
@ -162,8 +162,8 @@ Vim script example~
" syntax off " Disable syntax highlighting " syntax off " Disable syntax highlighting
< <
Lua configuration example for Neovim~ < Lua example for Neovim >____________________________________________________~
*plug-lua-configuration-example-for-neovim* *plug-lua-example-for-neovim*
In Neovim, you can write your configuration in a Lua script file named In Neovim, you can write your configuration in a Lua script file named
`init.lua`. The following code is the Lua script equivalent to the Vim script `init.lua`. The following code is the Lua script equivalent to the Vim script
@ -211,16 +211,9 @@ example above.
vim.call('plug#end') vim.call('plug#end')
< <
More examples can be found in:
- https://gitlab.com/sultanahamer/dotfiles/-/blob/master/nvim/lua/plugins.lua?ref_type=heads COMMANDS *plug-commands*
==============================================================================
< Commands >__________________________________________________________________~
*plug-commands*
*:PlugInstall* *:PlugUpdate* *:PlugClean* *:PlugUpgrade* *:PlugStatus* *:PlugDiff*
*:PlugSnapshot*
-------------------------------------+------------------------------------------------------------------ -------------------------------------+------------------------------------------------------------------
Command | Description ~ Command | Description ~
@ -235,8 +228,8 @@ More examples can be found in:
-------------------------------------+------------------------------------------------------------------ -------------------------------------+------------------------------------------------------------------
< Plug options >______________________________________________________________~ PLUG OPTIONS *plug-options*
*plug-options* ==============================================================================
*<Plug>-mappings* *<Plug>-mappings*
@ -254,8 +247,8 @@ More examples can be found in:
------------------------+------------------------------------------------------------ ------------------------+------------------------------------------------------------
< Global options >____________________________________________________________~ GLOBAL OPTIONS *plug-global-options*
*plug-global-options* ==============================================================================
*g:plug_threads* *g:plug_timeout* *g:plug_retries* *g:plug_shallow* *g:plug_window* *g:plug_threads* *g:plug_timeout* *g:plug_retries* *g:plug_shallow* *g:plug_window*
*g:plug_pwindow* *g:plug_url_format* *g:plug_pwindow* *g:plug_url_format*
@ -273,8 +266,8 @@ More examples can be found in:
--------------------+-----------------------------------+----------------------------------------------------------------------------------- --------------------+-----------------------------------+-----------------------------------------------------------------------------------
< Keybindings >_______________________________________________________________~ KEYBINDINGS *plug-keybindings*
*plug-keybindings* ==============================================================================
- `D` - `PlugDiff` - `D` - `PlugDiff`
- `S` - `PlugStatus` - `S` - `PlugStatus`
@ -287,8 +280,8 @@ More examples can be found in:
- `X` - Revert the update - `X` - Revert the update
< Post-update hooks >_________________________________________________________~ POST-UPDATE HOOKS *plug-post-update-hooks*
*plug-post-update-hooks* ==============================================================================
There are some plugins that require extra steps after installation or update. There are some plugins that require extra steps after installation or update.
In that case, use the `do` option to describe the task to be performed. In that case, use the `do` option to describe the task to be performed.
@ -323,9 +316,9 @@ A post-update hook is executed inside the directory of the plugin and only run
when the repository has changed, but you can force it to run unconditionally when the repository has changed, but you can force it to run unconditionally
with the bang-versions of the commands: `PlugInstall!` and `PlugUpdate!`. with the bang-versions of the commands: `PlugInstall!` and `PlugUpdate!`.
Make sure to escape BARs and double-quotes when you write the `do` option [!TIP] Make sure to escape BARs and double-quotes when you write the `do`
inline as they are mistakenly recognized as command separator or the start of option inline as they are mistakenly recognized as command separator or the
the trailing comment. start of the trailing comment.
> >
Plug 'junegunn/fzf', { 'do': 'yes \| ./install' } Plug 'junegunn/fzf', { 'do': 'yes \| ./install' }
< <
@ -336,7 +329,7 @@ variable (or any Vim script expression) as follows:
Plug 'junegunn/fzf', { 'do': g:fzf_install } Plug 'junegunn/fzf', { 'do': g:fzf_install }
< <
PlugInstall! and PlugUpdate!~ < PlugInstall! and PlugUpdate! >______________________________________________~
*pluginstall-and-plugupdate* *pluginstall-and-plugupdate*
The installer takes the following steps when installing/updating a plugin: The installer takes the following steps when installing/updating a plugin:
@ -351,8 +344,8 @@ The commands with the `!` suffix ensure that all steps are run
unconditionally. unconditionally.
< On-demand loading of plugins >______________________________________________~ ON-DEMAND LOADING OF PLUGINS *plug-on-demand-loading-of-plugins*
*plug-on-demand-loading-of-plugins* ==============================================================================
> >
" NERD tree will be loaded on the first invocation of NERDTreeToggle command " NERD tree will be loaded on the first invocation of NERDTreeToggle command
Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' } Plug 'preservim/nerdtree', { 'on': 'NERDTreeToggle' }
@ -408,8 +401,8 @@ loading of the plugin. You can manually load the plugin using
See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
< Collaborators >_____________________________________________________________~ COLLABORATORS *plug-collaborators*
*plug-collaborators* ==============================================================================
- {Jan Edmund Lazo}{7} - Windows support - {Jan Edmund Lazo}{7} - Windows support
- {Jeremy Pallats}{8} - Python installer - {Jeremy Pallats}{8} - Python installer
@ -418,8 +411,8 @@ See https://github.com/junegunn/vim-plug/wiki/tips#loading-plugins-manually
{8} https://github.com/starcraftman {8} https://github.com/starcraftman
< License >___________________________________________________________________~ LICENSE *plug-license*
*plug-license* ==============================================================================
MIT MIT