docs: Move standalone usage to modules section

This commit is contained in:
Matt Sturgeon 2024-04-01 12:05:46 +01:00 committed by Gaétan Lepage
parent db6b61f117
commit 87df94dcbd
3 changed files with 15 additions and 5 deletions

View file

@ -34,11 +34,11 @@
cat \ cat \
${./nixvim-header-start.5} \ ${./nixvim-header-start.5} \
${mkMDSection ../user-guide/helpers.md} \ ${mkMDSection ../user-guide/helpers.md} \
${mkMDSection ../user-guide/extending-config.md} \
${mkMDSection ../user-guide/faq.md} \ ${mkMDSection ../user-guide/faq.md} \
${./nixvim-header-end.5} \ ${./nixvim-header-end.5} \
>$out/nixvim-header.5 >$out/nixvim-header.5
''; '';
# FIXME add platform specific docs to manpage
in in
runCommand "nixvim-configuration-reference-manpage" { runCommand "nixvim-configuration-reference-manpage" {
nativeBuildInputs = [installShellFiles nixos-render-docs]; nativeBuildInputs = [installShellFiles nixos-render-docs];

View file

@ -4,12 +4,12 @@
- [Installation](./user-guide/install.md) - [Installation](./user-guide/install.md)
- [Helpers](./user-guide/helpers.md) - [Helpers](./user-guide/helpers.md)
- [Extending a standalone configuration](./user-guide/extending-config.md)
- [FAQ](./user-guide/faq.md) - [FAQ](./user-guide/faq.md)
# Module Specific Options # Platforms
- [Home Manager Usage](./modules/hm.md) - [Home Manager Usage](./modules/hm.md)
- [Standalone Usage](./modules/standalone.md)
# Options # Options

View file

@ -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. 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. This attribute is recursive, meaning that it can be applied an arbitrary number of times.
## Example ### Example
```nix ```nix
{makeNixvimWithModule}: let {makeNixvimWithModule}: let
@ -24,3 +33,4 @@ in
``` ```
This will generate a `init.lua` that will contain the three comments from each stages. This will generate a `init.lua` that will contain the three comments from each stages.