diff --git a/docs/man/default.nix b/docs/man/default.nix index 42ee9cea..25b996b4 100644 --- a/docs/man/default.nix +++ b/docs/man/default.nix @@ -34,11 +34,11 @@ cat \ ${./nixvim-header-start.5} \ ${mkMDSection ../user-guide/helpers.md} \ - ${mkMDSection ../user-guide/extending-config.md} \ ${mkMDSection ../user-guide/faq.md} \ ${./nixvim-header-end.5} \ >$out/nixvim-header.5 ''; + # FIXME add platform specific docs to manpage in runCommand "nixvim-configuration-reference-manpage" { nativeBuildInputs = [installShellFiles nixos-render-docs]; diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md index 3ce2fb54..c73604fa 100644 --- a/docs/mdbook/SUMMARY.md +++ b/docs/mdbook/SUMMARY.md @@ -4,12 +4,12 @@ - [Installation](./user-guide/install.md) - [Helpers](./user-guide/helpers.md) -- [Extending a standalone configuration](./user-guide/extending-config.md) - [FAQ](./user-guide/faq.md) -# Module Specific Options +# Platforms - [Home Manager Usage](./modules/hm.md) +- [Standalone Usage](./modules/standalone.md) # Options diff --git a/docs/user-guide/extending-config.md b/docs/modules/standalone.md similarity index 71% rename from docs/user-guide/extending-config.md rename to docs/modules/standalone.md index 01686f77..8159b082 100644 --- a/docs/user-guide/extending-config.md +++ b/docs/modules/standalone.md @@ -1,4 +1,13 @@ -# Extending a standalone configuration +# Standalone Usage + +## Options + +When used standalone, nixvim's options are available directly, without any prefix/namespace. +This is unlike the other modules which typically use a `programs.nixvim.*` prefix. + +There are **no** standalone-specific options available. + +## Extending an existing configuration Given a `nvim` derivation obtained from `makeNixvim` or `makeNivxmiWithModule` it is possible to create a new derivation with additional options. @@ -6,7 +15,7 @@ This is done through the `nvim.nixvimExtend` function. This function takes a Nix This attribute is recursive, meaning that it can be applied an arbitrary number of times. -## Example +### Example ```nix {makeNixvimWithModule}: let @@ -24,3 +33,4 @@ in ``` This will generate a `init.lua` that will contain the three comments from each stages. +