Skip to content

Commit

Permalink
docs/user-guide: add sub-headings to helpers.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MattSturgeon committed Jan 17, 2025
1 parent ff29c97 commit b28ebf2
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/user-guide/helpers.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit b28ebf2

Please sign in to comment.