NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-11-04 12:42:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/installation: mark additional inputs as 'optional'
Some checks failed
Check for typos in the source tree / check-typos (push) Waiting to run
Details
Set up binary cache / cachix (default) (push) Has been cancelled
Details
Set up binary cache / cachix (maximal) (push) Has been cancelled
Details
Set up binary cache / cachix (nix) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs-html) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs-json) (push) Has been cancelled
Details
Validate flake & check documentation / Validate Flake Documentation (docs-manpages) (push) Has been cancelled
Details
Validate flake & check documentation / Validate hyperlinks in documentation sources (push) Has been cancelled
Details
Validate flake & check formatting / Validate Flake (push) Has been cancelled
Details
Validate flake & check formatting / Formatting via Alejandra (push) Has been cancelled
Details
Build and deploy documentation / Check latest commit (push) Has been cancelled
Details
Build and deploy documentation / publish (push) Has been cancelled
Details

Browse source
This commit is contained in:
raf 2025-01-07 04:19:57 +03:00
commit 2728e65a5e
No known key found for this signature in database
GPG key ID: EED98D11B85A2819
2 changed files with 18 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -10,12 +10,18 @@ To use it, we first add the input 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 = {
url = "github:notashelf/nvf";
# you can override input nixpkgs
# 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";
# you can also override individual plugins
# Optionally, you can also override individual plugins
# for example:
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
};
@ -27,8 +33,8 @@ Followed by importing the home-manager 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 installation below
imports = [ inputs.nvf.homeManagerModules.default ];
}
```

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

@ -10,12 +10,18 @@ To use it, we first add the input 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 = {
url = "github:notashelf/nvf";
# you can override input nixpkgs
# 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";
# you can also override individual plugins
# Optionally, you can also override individual plugins
# for example:
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
};