docs: move wrapper-options to summary index page

This commit is contained in:
Matt Sturgeon 2024-10-23 17:49:39 +01:00
parent cd68b680cd
commit 131e74e560
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
4 changed files with 4 additions and 4 deletions

View file

@ -11,8 +11,8 @@
# Platforms # Platforms
- [Platform-specific options](./platforms/wrapper-options.md) - [Nixvim Platforms](./platforms/index.md)
- [Standalone Usage](./platforms/standalone.md) - [Standalone](./platforms/standalone.md)
# Options # Options

View file

@ -328,7 +328,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
substituteInPlace ./SUMMARY.md \ substituteInPlace ./SUMMARY.md \
--replace-fail "@NIXVIM_OPTIONS@" "$nixvimOptionsSummary" --replace-fail "@NIXVIM_OPTIONS@" "$nixvimOptionsSummary"
substituteInPlace ./platforms/wrapper-options.md \ substituteInPlace ./platforms/index.md \
--replace-fail "@WRAPPER_OPTIONS@" "$(cat ${finalAttrs.passthru.wrapperOptionDocs})" --replace-fail "@WRAPPER_OPTIONS@" "$(cat ${finalAttrs.passthru.wrapperOptionDocs})"
mdbook build mdbook build

View file

@ -70,7 +70,7 @@ options as `programs.nixvim.<path>.<to>.<option> = <value>`.
When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for home-manager, NixOS, and nix-darwin respectively. When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for home-manager, NixOS, and nix-darwin respectively.
This is useful is you use nixvim both as part of an environment and as standalone. This is useful is you use nixvim both as part of an environment and as standalone.
For more information on module-specific options, see [Platform-specific options](../platforms/wrapper-options.md). For more platform-specific options and information, see [Nixvim Platforms](../platforms/index.md).
### Standalone usage ### Standalone usage