Commit Graph

4 Commits

Author SHA1 Message Date
Matthieu C.
3e6edb83dd vimPlugins: rename nvimSkipModule into nvimSkipModules
It's confusing to have a polymorphic behavior for nvimSkipModule and it
is an implementation detail.
Let's not force ourselves to keep supporting both types and just support
lists, which imply plural in nixpkgs (e.g. "lib.optional" vs "lib.optionals").

Support and showcase just the list format to avoid confusion.
2025-03-27 16:34:28 +01:00
Peder Bergebakken Sundt
d525eb5838 treewide: fix typos
done with `fd \\\.md$ . --type f -x typos --write-changes`
2025-02-22 02:02:07 +01:00
Matthieu Coudron
9c73444257
doc/neovim: better document the wrappers (#373805)
* doc/neovim: better document the wrappers

there is new wrapper interface `wrapNeovimUnstable` in development intended to be
easier to use than the old `wrapNeovim`. It provides new fancy features that we would like to
leverage/advertise
The interface is not definitive yet so we provide a translation layer
to avoid breaking user configurations such that `wrapNeovim` still works.
This explains why we document both at the moment with the goal to remove
the old one once we ciment the interface.

* doc/neovim: explain what buildNeovimPlugin does
2025-01-17 17:03:13 -06:00
Matthieu C.
3f2423e8a8 doc/neovim: move neovim to its own section
I wanted to add instructions on how to configure neovim via the new
wrapper but it was difficult mixing this with both the vim and old
wrapper.
Neovim differs enough from vim to warrant its own section IMO:
1. its wrapper is different (old wrapper close to vim's syntax, new one
   not so much)
2. treesitter is unique to neovim
3. the section about neovim plugins is unique to neovim as well. Not
   only that but it needs to expanded.

At some point the doc unique to vim is going to exceed vim's.
We can refer to vim's section to avoid duplication where it makes sense.
2025-01-12 23:33:32 +01:00