mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-01-15 14:32:23 +00:00
docs/installation: mark additional inputs as 'optional'
Some checks failed
Check for typos in the source tree / check-typos (push) Waiting to run
Set up binary cache / cachix (default) (push) Has been cancelled
Set up binary cache / cachix (maximal) (push) Has been cancelled
Set up binary cache / cachix (nix) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs-html) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs-json) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs-manpages) (push) Has been cancelled
Validate flake & check documentation / Validate hyperlinks in documentation sources (push) Has been cancelled
Validate flake & check formatting / Validate Flake (push) Has been cancelled
Validate flake & check formatting / Formatting via Alejandra (push) Has been cancelled
Build and deploy documentation / Check latest commit (push) Has been cancelled
Build and deploy documentation / publish (push) Has been cancelled
Some checks failed
Check for typos in the source tree / check-typos (push) Waiting to run
Set up binary cache / cachix (default) (push) Has been cancelled
Set up binary cache / cachix (maximal) (push) Has been cancelled
Set up binary cache / cachix (nix) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs-html) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs-json) (push) Has been cancelled
Validate flake & check documentation / Validate Flake Documentation (docs-manpages) (push) Has been cancelled
Validate flake & check documentation / Validate hyperlinks in documentation sources (push) Has been cancelled
Validate flake & check formatting / Validate Flake (push) Has been cancelled
Validate flake & check formatting / Formatting via Alejandra (push) Has been cancelled
Build and deploy documentation / Check latest commit (push) Has been cancelled
Build and deploy documentation / publish (push) Has been cancelled
This commit is contained in:
parent
a1bac1d356
commit
2728e65a5e
2 changed files with 18 additions and 6 deletions
|
@ -10,12 +10,18 @@ To use it, we first add the input flake.
|
||||||
```nix
|
```nix
|
||||||
{
|
{
|
||||||
inputs = {
|
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";
|
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 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";
|
inputs.nixpkgs.follows = "nixpkgs";
|
||||||
# you can also override individual plugins
|
# Optionally, you can also override individual plugins
|
||||||
# for example:
|
# for example:
|
||||||
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
|
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
|
```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 installation below
|
||||||
imports = [ inputs.nvf.homeManagerModules.default ];
|
imports = [ inputs.nvf.homeManagerModules.default ];
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
|
@ -10,12 +10,18 @@ To use it, we first add the input flake.
|
||||||
```nix
|
```nix
|
||||||
{
|
{
|
||||||
inputs = {
|
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";
|
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 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";
|
inputs.nixpkgs.follows = "nixpkgs";
|
||||||
# you can also override individual plugins
|
# Optionally, you can also override individual plugins
|
||||||
# for example:
|
# for example:
|
||||||
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
|
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in a new issue