NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2026-01-11 05:06:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs/modules: remove outdated and incorrect input-following suggestions

Browse source
This commit is contained in:
alfarel 2025-10-31 19:47:24 +00:00
commit 0d90eb4be1
No known key found for this signature in database
2 changed files with 6 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/manual/installation/modules/home-manager.md
View file

@ -19,20 +19,13 @@ To use **nvf** with flakes, we first need to add the input to our `flake.nix`.
# flake.nix # flake.nix
{ {
inputs = { inputs = {
# Optional, if you intend to follow nvf's obsidian-nvim input # nvf works best with and only directly supports flakes
# 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 = { nvf = {
url = "github:NotAShelf/nvf"; url = "github:NotAShelf/nvf";
# You can override the input nixpkgs to follow your system's # You can override the input nixpkgs to follow your system's
# instance of nixpkgs. This is safe to do as nvf does not depend # instance of nixpkgs. This is safe to do as nvf does not depend
# on a binary cache. # on a binary cache.
inputs.nixpkgs.follows = "nixpkgs"; 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 ```nix
{ {
# Assuming "nvf" is in your inputs and inputs is in the argument set. # Assuming nvf is in your inputs and inputs is in the argument set.
# See example installation below # See example installation below.
imports = [ inputs.nvf.homeManagerModules.default ]; imports = [ inputs.nvf.homeManagerModules.default ];
} }
``` ```

14
docs/manual/installation/modules/nixos.md
View file

@ -19,20 +19,13 @@ To use **nvf** with flakes, we first need to add the input to our `flake.nix`.
# flake.nix # flake.nix
{ {
inputs = { inputs = {
# Optional, if you intend to follow nvf's obsidian-nvim input # nvf works best with and only directly supports flakes
# 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 = { nvf = {
url = "github:NotAShelf/nvf"; url = "github:NotAShelf/nvf";
# You can override the input nixpkgs to follow your system's # You can override the input nixpkgs to follow your system's
# instance of nixpkgs. This is safe to do as nvf does not depend # instance of nixpkgs. This is safe to do as nvf does not depend
# on a binary cache. # on a binary cache.
inputs.nixpkgs.follows = "nixpkgs"; 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 ```nix
{ {
# assuming nvf is in your inputs and inputs is in the argset # Assuming nvf is in your inputs and inputs is in the argument set.
# see example below # See example below.
imports = [ inputs.nvf.nixosModules.default ]; imports = [ inputs.nvf.nixosModules.default ];
} }
``` ```
@ -79,7 +72,6 @@ configure **nvf**.
{ {
programs.nvf = { programs.nvf = {
enable = true; enable = true;
# Your settings need to go into the settings attribute set # Your settings need to go into the settings attribute set
# most settings are documented in the appendix # most settings are documented in the appendix
settings = { settings = {