Skip to content

Commit

Permalink
Added caveat section to options (nix-community#222)
Browse files Browse the repository at this point in the history
Since the options set could be treated as options for a module, it
should be wrapped with config to work, when using makeNixvimWithModule.
  • Loading branch information
Alexnortung authored Mar 4, 2023
1 parent 2258eb8 commit c5f31f5
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
`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
It is fully possible to define key mappings from within NixVim. This is done
using the `maps` attribute:
Expand Down

0 comments on commit c5f31f5

Please sign in to comment.