diff --git a/docs/manual/installation/modules/home-manager.md b/docs/manual/installation/modules/home-manager.md index 916208ce..f5d85b72 100644 --- a/docs/manual/installation/modules/home-manager.md +++ b/docs/manual/installation/modules/home-manager.md @@ -19,20 +19,13 @@ To use **nvf** with flakes, we first need to add the input to our `flake.nix`. # flake.nix { inputs = { - # Optional, if you intend to follow nvf's obsidian-nvim input - # you must also add it as a flake input. - obsidian-nvim.url = "github:epwalsh/obsidian.nvim"; - - # Required, nvf works best and only directly supports flakes + # nvf works best with and only directly supports flakes nvf = { url = "github:NotAShelf/nvf"; # You can override the input nixpkgs to follow your system's # instance of nixpkgs. This is safe to do as nvf does not depend # on a binary cache. inputs.nixpkgs.follows = "nixpkgs"; - # Optionally, you can also override individual plugins - # for example: - inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs }; # ... @@ -44,8 +37,8 @@ Followed by importing the home-manager module somewhere in your configuration. ```nix { - # Assuming "nvf" is in your inputs and inputs is in the argument set. - # See example installation below + # Assuming nvf is in your inputs and inputs is in the argument set. + # See example installation below. imports = [ inputs.nvf.homeManagerModules.default ]; } ``` diff --git a/docs/manual/installation/modules/nixos.md b/docs/manual/installation/modules/nixos.md index 0186465b..95a0fc8f 100644 --- a/docs/manual/installation/modules/nixos.md +++ b/docs/manual/installation/modules/nixos.md @@ -19,20 +19,13 @@ To use **nvf** with flakes, we first need to add the input to our `flake.nix`. # flake.nix { inputs = { - # Optional, if you intend to follow nvf's obsidian-nvim input - # you must also add it as a flake input. - obsidian-nvim.url = "github:epwalsh/obsidian.nvim"; - - # Required, nvf works best and only directly supports flakes + # nvf works best with and only directly supports flakes nvf = { url = "github:NotAShelf/nvf"; # You can override the input nixpkgs to follow your system's # instance of nixpkgs. This is safe to do as nvf does not depend # on a binary cache. inputs.nixpkgs.follows = "nixpkgs"; - # Optionally, you can also override individual plugins - # for example: - inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs }; # ... @@ -44,8 +37,8 @@ Followed by importing the NixOS module somewhere in your configuration. ```nix { - # assuming nvf is in your inputs and inputs is in the argset - # see example below + # Assuming nvf is in your inputs and inputs is in the argument set. + # See example below. imports = [ inputs.nvf.nixosModules.default ]; } ``` @@ -79,7 +72,6 @@ configure **nvf**. { programs.nvf = { enable = true; - # Your settings need to go into the settings attribute set # most settings are documented in the appendix settings = {