From f4683e3439966c5702e5168d5ee0c910d31ab867 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karl=20Yngve=20Lerv=C3=A5g?= Date: Fri, 25 Dec 2015 23:16:47 +0100 Subject: [PATCH] Added a FAQ entry about neovim (#262) --- doc/vimtex.txt | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/vimtex.txt b/doc/vimtex.txt index b8c1696..fb36bbe 100644 --- a/doc/vimtex.txt +++ b/doc/vimtex.txt @@ -1662,6 +1662,29 @@ A: This might be due to the |isfname| setting, which by default contains `{,}` `vimtex`. Suggested solution is to remove `{,}` from |isfname| by: > set isfname-={,} +< + *vimtex-faq-neovim* +Q: Does |vimtex| work with neovim? +A: Yes, partly. Most features work out of the box, but the `latexmk` coupling + and some if the viewer functionality require the |--remote| options from + the |clientserver|. For some reason, these options have been removed from + neovim, see #1750 [0]. There does remain some hope that the options will be + reimplemented sometime in the future, and there is an open issue on vimtex + (#262 [1]) that will remain open until neovim is fully supported. + + In the meantime, there exists a workaround: `neovim-remote` [2] is a simple + tool that implements the |--remote| options through a python script. If one + downloads this tool and sets the option |g:vimtex_latexmk_progname| to + `nvr` (or the full path, if `nvr` is not in `$PATH`), then everything + should work. + + Note: I do not plan to implement a custom solution for neovim in |vimtex|. + This means that support for neovim must either come from an update on + the neovim issue #1750, or through the mentioned workaround. + + [0]: https://github.com/neovim/neovim/issues/1750 + [1]: https://github.com/lervag/vimtex/issues/262 + [2]: https://github.com/mhinz/neovim-remote ============================================================================== CREDITS *vimtex-credits*