From 3f1daea5bd4f7a9d1211996ea706daf3b639bf05 Mon Sep 17 00:00:00 2001 From: Junegunn Choi Date: Wed, 15 May 2024 03:07:01 +0900 Subject: [PATCH] Adjust heading levels in README --- README.md | 50 +++++++++++------------ doc/plug.txt | 111 ++++++++++++++++++++++++--------------------------- 2 files changed, 75 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 6e09eac2..5403a4bc 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ A minimalist Vim plugin manager. -### Pros. +## Pros. - Minimalist design - 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 [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) and put it in the "autoload" directory. @@ -57,9 +57,9 @@ and put it in the "autoload" directory.
Click to see the instructions -#### Vim +### Vim -###### Unix +#### Unix ```sh 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 -###### Windows (PowerShell) +#### Windows (PowerShell) ```powershell iwr -useb https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim |` ni $HOME/vimfiles/autoload/plug.vim -Force ``` -#### Neovim +### Neovim -###### Unix, Linux +#### Unix, Linux ```sh 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' ``` -###### Linux (Flatpak) +#### Linux (Flatpak) ```sh 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 ``` -###### Windows (PowerShell) +#### Windows (PowerShell) ```powershell 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 |`
-### Usage +## Usage 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 > options. -#### Getting Help +### Getting Help - See [tutorial] page to learn more about the basics of vim-plug - 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 [FAQ]: https://github.com/junegunn/vim-plug/wiki/faq -### More examples +## Examples The following examples demonstrate the additional features of vim-plug. -#### Vim script example +### Vim script example ```vim call plug#begin() @@ -201,7 +201,7 @@ call plug#end() " 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 `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') ``` -More examples can be found in: - -* https://gitlab.com/sultanahamer/dotfiles/-/blob/master/nvim/lua/plugins.lua?ref_type=heads - -### Commands +## Commands | Command | Description | | ----------------------------------- | ------------------------------------------------------------------ | @@ -267,7 +263,7 @@ More examples can be found in: | `PlugDiff` | Examine changes from the previous update and the pending changes | | `PlugSnapshot[!] [output path]` | Generate script for restoring the current snapshot of the plugins | -### `Plug` options +## `Plug` options | Option | Description | | ----------------------- | ----------------------------------------------------------- | @@ -280,7 +276,7 @@ More examples can be found in: | `for` | On-demand loading: File types | | `frozen` | Do not remove and do not update unless explicitly specified | -### Global options +## Global options | 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) | -### Keybindings +## Keybindings - `D` - `PlugDiff` - `S` - `PlugStatus` @@ -305,7 +301,7 @@ More examples can be found in: - `:PlugDiff` - `X` - Revert the update -### Post-update hooks +## Post-update hooks 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. @@ -365,7 +361,7 @@ with the bang-versions of the commands: `PlugInstall!` and `PlugUpdate!`. > Plug 'junegunn/fzf', { 'do': g:fzf_install } > ``` -#### `PlugInstall!` and `PlugUpdate!` +### `PlugInstall!` and `PlugUpdate!` 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. -### On-demand loading of plugins +## On-demand loading of plugins ```vim " 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 -### Collaborators +## Collaborators - [Jan Edmund Lazo](https://github.com/janlazo) - Windows support - [Jeremy Pallats](https://github.com/starcraftman) - Python installer -### License +## License MIT diff --git a/doc/plug.txt b/doc/plug.txt index 507124a5..06d985fe 100644 --- a/doc/plug.txt +++ b/doc/plug.txt @@ -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* ============================================================================== - vim-plug |vim-plug| - Pros. |plug-pros| - Installation |plug-installation| - Usage |plug-usage| - Getting Help |plug-getting-help| - More examples |plug-more-examples| - Vim script example |plug-vim-script-example| - Lua configuration example for Neovim |plug-lua-configuration-example-for-neovim| - Commands |plug-commands| - Plug options |plug-options| - Global options |plug-global-options| - Keybindings |plug-keybindings| - Post-update hooks |plug-post-update-hooks| - PlugInstall! and PlugUpdate! |pluginstall-and-plugupdate| - On-demand loading of plugins |plug-on-demand-loading-of-plugins| - Collaborators |plug-collaborators| - License |plug-license| + vim-plug |vim-plug| + Pros. |plug-pros| + Installation |plug-installation| + Usage |plug-usage| + Getting Help |plug-getting-help| + Examples |plug-examples| + Vim script example |plug-vim-script-example| + Lua example for Neovim |plug-lua-example-for-neovim| + Commands |plug-commands| + Plug options |plug-options| + Global options |plug-global-options| + Keybindings |plug-keybindings| + Post-update hooks |plug-post-update-hooks| + PlugInstall! and PlugUpdate! |pluginstall-and-plugupdate| + On-demand loading of plugins |plug-on-demand-loading-of-plugins| + Collaborators |plug-collaborators| + License |plug-license| VIM-PLUG *vim-plug* ============================================================================== @@ -26,8 +26,8 @@ VIM-PLUG *vim-plug* A minimalist Vim plugin manager. -< Pros. >_____________________________________________________________________~ - *plug-pros* +PROS. *plug-pros* +============================================================================== - Minimalist design - Just one file with no dependencies. Super easy to set up. @@ -35,8 +35,8 @@ A minimalist Vim plugin manager. boilerplate code required. - No feature bloat - Extremely stable with flawless backward compatibility - - Works perfectly with Vim 7.0+ since 2006 and with all versions of Neovim - since 2014 + - Works perfectly with all versions of Vim since 2006 and all versions of + Neovim ever released - {Super-fast}{1} parallel installation/update - Creates shallow clones to minimize disk space usage and download time - 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 -< Installation >______________________________________________________________~ - *plug-installation* +INSTALLATION *plug-installation* +============================================================================== {Download plug.vim}{3} and put it in the "autoload" directory. {3} https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim -< Usage >_____________________________________________________________________~ - *plug-usage* +USAGE *plug-usage* +============================================================================== 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. -Getting Help~ +< Getting Help >______________________________________________________________~ *plug-getting-help* - 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 -< More examples >_____________________________________________________________~ - *plug-more-examples* +EXAMPLES *plug-examples* +============================================================================== The following examples demonstrate the additional features of vim-plug. -Vim script example~ +< Vim script example >________________________________________________________~ *plug-vim-script-example* > call plug#begin() @@ -162,8 +162,8 @@ Vim script example~ " syntax off " Disable syntax highlighting < -Lua configuration example for Neovim~ - *plug-lua-configuration-example-for-neovim* +< Lua example for Neovim >____________________________________________________~ + *plug-lua-example-for-neovim* 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 @@ -211,16 +211,9 @@ example above. 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* - - *:PlugInstall* *:PlugUpdate* *:PlugClean* *:PlugUpgrade* *:PlugStatus* *:PlugDiff* - *:PlugSnapshot* +COMMANDS *plug-commands* +============================================================================== -------------------------------------+------------------------------------------------------------------ Command | Description ~ @@ -235,8 +228,8 @@ More examples can be found in: -------------------------------------+------------------------------------------------------------------ -< Plug options >______________________________________________________________~ - *plug-options* +PLUG OPTIONS *plug-options* +============================================================================== *-mappings* @@ -254,8 +247,8 @@ More examples can be found in: ------------------------+------------------------------------------------------------ -< Global options >____________________________________________________________~ - *plug-global-options* +GLOBAL OPTIONS *plug-global-options* +============================================================================== *g:plug_threads* *g:plug_timeout* *g:plug_retries* *g:plug_shallow* *g:plug_window* *g:plug_pwindow* *g:plug_url_format* @@ -273,8 +266,8 @@ More examples can be found in: --------------------+-----------------------------------+----------------------------------------------------------------------------------- -< Keybindings >_______________________________________________________________~ - *plug-keybindings* +KEYBINDINGS *plug-keybindings* +============================================================================== - `D` - `PlugDiff` - `S` - `PlugStatus` @@ -287,8 +280,8 @@ More examples can be found in: - `X` - Revert the update -< Post-update hooks >_________________________________________________________~ - *plug-post-update-hooks* +POST-UPDATE HOOKS *plug-post-update-hooks* +============================================================================== 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. @@ -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 with the bang-versions of the commands: `PlugInstall!` and `PlugUpdate!`. -Make sure to escape BARs and double-quotes when you write the `do` option -inline as they are mistakenly recognized as command separator or the start of -the trailing comment. +[!TIP] Make sure to escape BARs and double-quotes when you write the `do` +option inline as they are mistakenly recognized as command separator or the +start of the trailing comment. > 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 } < -PlugInstall! and PlugUpdate!~ +< PlugInstall! and PlugUpdate! >______________________________________________~ *pluginstall-and-plugupdate* 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. -< On-demand loading of plugins >______________________________________________~ - *plug-on-demand-loading-of-plugins* +ON-DEMAND LOADING OF PLUGINS *plug-on-demand-loading-of-plugins* +============================================================================== > " NERD tree will be loaded on the first invocation of NERDTreeToggle command 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 -< Collaborators >_____________________________________________________________~ - *plug-collaborators* +COLLABORATORS *plug-collaborators* +============================================================================== - {Jan Edmund Lazo}{7} - Windows support - {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 -< License >___________________________________________________________________~ - *plug-license* +LICENSE *plug-license* +============================================================================== MIT