diff --git a/README.md b/README.md index b464998ee2..49d62ca4ca 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,13 @@ Or use some other plugin manager: * [neobundle](https://github.com/Shougo/neobundle.vim) * [pathogen](https://github.com/tpope/vim-pathogen) +**Note**: Many plugin managers provide mechanisms to lazy load plugins. Please + don't use this for VimTeX! VimTeX is already lazy loaded by virtue of being + a filetype plugin and by using the autoload mechanisms. There is therefore + nothing to gain by forcing VimTeX to lazily load through the plugin + manager. In fact, doing it will _break_ the inverse-search mechanism, which + relies on a _global_ command (`:VimtexInverseSearch`). + If you use the new package feature in Vim, please note the following: * Make sure to read and understand the package feature: `:help package`! * Use the `/pack/foo/start` subdirectory to make sure the filetype plugin is diff --git a/doc/vimtex.txt b/doc/vimtex.txt index 334c9fa180..d170933c1a 100644 --- a/doc/vimtex.txt +++ b/doc/vimtex.txt @@ -5503,6 +5503,10 @@ This may be avoided, or at least reduced, with the following variants: > Note: Vim users should be aware that one may need to ensure that the server is really running, see |vimtex-clientserver|. +Note: Many plugin managers provide mechanisms to lazy load plugins. There is + no need to use such a mechanism for VimTeX, and in fact, doing it will + prevent Vim/neovim from loading the `:VimtexInverseSearch` command. + ============================================================================== LATEX DOCUMENTATION *vimtex-latexdoc*