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

docs/user-guide: fix blurb on accessing helpers

Browse source 
Fixes #1220
This commit is contained in:
Matt Sturgeon 2024-07-08 08:37:46 +01:00
parent 8b9ba44195
commit 8c44124a1f
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
1 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/user-guide/helpers.md
View file

@ -1,16 +1,24 @@
# Helpers
Regardless of the way NixVim is used (as a home-manager module, a nixos module, or as a standalone module),
helpers can be included in the same way.
You can simply use:
If Nixvim is built using the standalone method, you can access our `helpers` as a module arg:
```nix
{ helpers, ... }:
{
helpers,
...
}: {
# Your config
# Your config
}
```
If Nixvim is being used as as a home-manager module, a nixos module, or as a dawwin module,
helpers can be accessed via the `config.nixvim.helpers` option:
```nix
{ config, ... }:
let
inherit (config.nixvim) helpers;
in
{
# Your config
}
```