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

docs/user-guide: add sub-headings to helpers.md

Browse source
This commit is contained in:
Matt Sturgeon 2025-01-17 00:04:06 +00:00
parent ff29c97723
commit b28ebf2535
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,5 +1,7 @@
# Helpers
## Accessing Nixvim's functions
If Nixvim is built using the standalone method, you can access our "helpers" as part of the `lib` module arg:
```nix
@ -37,6 +39,8 @@ This "extended" lib, includes everything normally in `lib`, along with some addi
**Note:** the `lib` argument passed to modules is entirely unrelated to the `lib` _option_ accessed as `config.lib`!
## Common helper functions
A certain number of helpers are defined that can be useful:
- `helpers.emptyTable`: An empty lua table `{}` that will be included in the final lua configuration.