mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-26 10:48:35 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: refactor wrapper-options docs

Browse source
This commit is contained in:
Matt Sturgeon 2024-10-21 17:17:15 +01:00
parent 5992a22821
commit 0562e519ec
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
6 changed files with 54 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/modules/hm.md
View file

@ -1,6 +0,0 @@
# Home Manager Usage
All nixvim options are available at `programs.nixvim.*` when nixvim is used in home-manager.
There are a few home-manager specific options that are documented here.
@HM_OPTIONS@

24
docs/modules/wrapper-options.md Normal file
View file

@ -0,0 +1,24 @@
# Platform-specific options
All of Nixvim's options are available within `programs.nixvim.*` when Nixvim is used via wrapper modules,
such as our NixOS, home-manager, or nix-darwin modules.
When Nixvim is used standalone (without a wrapper module), its options are available at the "top-level".
See [Standalone Usage](./standalone.md) for more info.
There are a few wrapper specific options that are documented below:
## NixOS
@NIXOS_OPTIONS@
## home-manager
@HM_OPTIONS@
## nix-darwin
@DARWIN_OPTIONS@
<!-- TODO: Add @STANDALONE_OPTIONS@ if we ever have standalone-specific options -->