Skip to content

Commit e880fe7

Browse files
TomasTomecekjustinmk
authored andcommitted
doc
1 parent debcde0 commit e880fe7

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
# Add any paths that contain custom static files (such as style sheets) here,
9999
# relative to this directory. They are copied after the builtin static files,
100100
# so a file named "default.css" will overwrite the builtin "default.css".
101-
html_static_path = ['_static']
101+
html_static_path = []
102102

103103

104104
# -- Options for HTMLHelp output ------------------------------------------

docs/usage/remote-plugins.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _remote-plugins:
2+
23
Remote (new-style) plugins
34
==========================
45

@@ -45,3 +46,40 @@ but it can make asynchronous requests, i.e. passing ``async=True``.
4546

4647
You need to run ``:UpdateRemotePlugins`` in Neovim for changes in the specifications to have effect.
4748
For details see ``:help remote-plugin`` in Neovim.
49+
50+
For local plugin development, it's a good idea to use an isolated vimrc:
51+
52+
.. code-block:: console
53+
54+
cat vimrc
55+
let &runtimepath.=','.escape(expand('<sfile>:p:h'), '\,')
56+
57+
That appends the current directory to the Nvim runtime path so Nvim can
58+
find your plugin. You can now invoke Neovim:
59+
60+
.. code-block:: console
61+
62+
nvim -u ./vimrc
63+
64+
Then run ``:UpdateRemotePlugins`` and your plugin should be activated.
65+
66+
In case you run into some issues, you can list loaded plugins:
67+
68+
.. code-block:: console
69+
70+
:scriptnames
71+
1: ~/path/to/your/plugin-git-repo/vimrc
72+
2: /usr/share/nvim/runtime/filetype.vim
73+
...
74+
25: /usr/share/nvim/runtime/plugin/zipPlugin.vim
75+
26: ~/path/to/your/plugin-git-repo/plugin/lucid.vim
76+
77+
You can also inspect the ``runtimepath`` like this:
78+
79+
.. code-block:: console
80+
81+
:set runtimepath
82+
runtimepath=~/.config/nvim,/etc/xdg/nvim,~/.local/share/nvim/site,...,
83+
,~/g/path/to/your/plugin-git-repo
84+
85+

0 commit comments

Comments
 (0)