mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-21 00:25:42 +02:00
docs: rename modules
-> platforms
This commit is contained in:
parent
c477b7865e
commit
cd68b680cd
8 changed files with 10 additions and 10 deletions
|
@ -256,7 +256,7 @@ It takes a set with the following keys:
|
||||||
- `extraSpecialArgs`: Extra arguments to pass to the modules when using functions.
|
- `extraSpecialArgs`: Extra arguments to pass to the modules when using functions.
|
||||||
Can be `self` in a flake, for example.
|
Can be `self` in a flake, for example.
|
||||||
|
|
||||||
For more detail, see the [Standalone Usage](https://nix-community.github.io/nixvim/modules/standalone.html) section of our documentation.
|
For more detail, see the [Standalone Usage](https://nix-community.github.io/nixvim/platforms/standalone.html) section of our documentation.
|
||||||
|
|
||||||
### With a `devShell`
|
### With a `devShell`
|
||||||
|
|
||||||
|
|
|
@ -11,8 +11,8 @@
|
||||||
|
|
||||||
# Platforms
|
# Platforms
|
||||||
|
|
||||||
- [Platform-specific options](./modules/wrapper-options.md)
|
- [Platform-specific options](./platforms/wrapper-options.md)
|
||||||
- [Standalone Usage](./modules/standalone.md)
|
- [Standalone Usage](./platforms/standalone.md)
|
||||||
|
|
||||||
# Options
|
# Options
|
||||||
|
|
||||||
|
|
|
@ -228,7 +228,7 @@ let
|
||||||
wrapperOptionFiles = lib.mapAttrs' (name: options: {
|
wrapperOptionFiles = lib.mapAttrs' (name: options: {
|
||||||
name = options.meta.wrapper.name.value;
|
name = options.meta.wrapper.name.value;
|
||||||
# TODO:
|
# TODO:
|
||||||
# value.path = "./modules/${name}.md";
|
# value.path = "./platforms/${name}.md";
|
||||||
value.file = mkMDDoc options;
|
value.file = mkMDDoc options;
|
||||||
}) wrapperOptions;
|
}) wrapperOptions;
|
||||||
|
|
||||||
|
@ -298,7 +298,7 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
|
||||||
root = ../../.;
|
root = ../../.;
|
||||||
fileset = lib.fileset.unions [
|
fileset = lib.fileset.unions [
|
||||||
../user-guide
|
../user-guide
|
||||||
../modules
|
../platforms
|
||||||
../../CONTRIBUTING.md
|
../../CONTRIBUTING.md
|
||||||
(lib.fileset.fileFilter (
|
(lib.fileset.fileFilter (
|
||||||
{ type, hasExt, ... }:
|
{ type, hasExt, ... }:
|
||||||
|
@ -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 ./modules/wrapper-options.md \
|
substituteInPlace ./platforms/wrapper-options.md \
|
||||||
--replace-fail "@WRAPPER_OPTIONS@" "$(cat ${finalAttrs.passthru.wrapperOptionDocs})"
|
--replace-fail "@WRAPPER_OPTIONS@" "$(cat ${finalAttrs.passthru.wrapperOptionDocs})"
|
||||||
|
|
||||||
mdbook build
|
mdbook build
|
||||||
|
|
|
@ -7,7 +7,7 @@ Take a look at these configuration examples below.
|
||||||
<!-- TODO: add info about `kickstart.nixvim` -->
|
<!-- TODO: add info about `kickstart.nixvim` -->
|
||||||
|
|
||||||
**Note:**\
|
**Note:**\
|
||||||
Most of those configurations are using a [standalone build](../modules/standalone.html), however,
|
Most of those configurations are using a [standalone build](../platforms/standalone.html), however,
|
||||||
all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).
|
all of the nixvim options are accessible no matter how you are using it (flake, NixOS/HM module, nix-darwin...).
|
||||||
|
|
||||||
| Config | Comment |
|
| Config | Comment |
|
||||||
|
|
|
@ -65,7 +65,7 @@ If you are building nixvim using the NixOS, home-manager, or nix-darwin modules
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system.
|
> Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system.
|
||||||
|
|
||||||
[standalone]: ./modules/standalone.md
|
[standalone]: ../platforms/standalone.md
|
||||||
|
|
||||||
## How do I create multiple aliases for a single keymap
|
## How do I create multiple aliases for a single keymap
|
||||||
|
|
||||||
|
|
|
@ -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](../modules/wrapper-options.md).
|
For more information on module-specific options, see [Platform-specific options](../platforms/wrapper-options.md).
|
||||||
|
|
||||||
### Standalone usage
|
### Standalone usage
|
||||||
|
|
||||||
|
@ -88,4 +88,4 @@ The nixvim derivation can then be used like any other package!
|
||||||
|
|
||||||
For an example, see the [nixvim standalone flake template](https://github.com/nix-community/nixvim/blob/main/templates/simple/flake.nix).
|
For an example, see the [nixvim standalone flake template](https://github.com/nix-community/nixvim/blob/main/templates/simple/flake.nix).
|
||||||
|
|
||||||
For more information see [Standalone Usage](../modules/standalone.md).
|
For more information see [Standalone Usage](../platforms/standalone.md).
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue