From b28ebf253592eaf97516a7bcfd231d7d76a5608e Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Fri, 17 Jan 2025 00:04:06 +0000 Subject: [PATCH] docs/user-guide: add sub-headings to `helpers.md` --- docs/user-guide/helpers.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user-guide/helpers.md b/docs/user-guide/helpers.md index 1573ccbd..65e80c1c 100644 --- a/docs/user-guide/helpers.md +++ b/docs/user-guide/helpers.md @@ -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.