mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 16:39:00 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Added caveat section to options (#222)

Browse source 
Since the options set could be treated as options for a module, it
should be wrapped with config to work, when using makeNixvimWithModule.
This commit is contained in:
Alexander Nortung 2023-03-04 02:26:13 +00:00 • committed by GitHub
parent 2258eb8df8
commit c5f31f5677
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -263,6 +263,20 @@ All of these are configurable from within NixVim. All you have to do is set the
Please note that to, for example, disable numbers you would not set Please note that to, for example, disable numbers you would not set
`options.nonumber` to true, you'd set `options.number` to false. `options.nonumber` to true, you'd set `options.number` to false.
### Caveats
If you are using `makeNixvimWithModule`, then options is treated as options for a module. To get around this just wrap the options in a `config` set.
```nix
{
config = {
options = {
# ...
};
};
}
```
## Key mappings ## Key mappings
It is fully possible to define key mappings from within NixVim. This is done It is fully possible to define key mappings from within NixVim. This is done
using the `maps` attribute: using the `maps` attribute: