1
0
Fork 0
mirror of https://github.com/NotAShelf/neovim-flake.git synced 2024-12-30 01:09:48 +01:00
neovim-flake/docs/manual/installation/modules/home-manager.md

84 lines
2.3 KiB
Markdown
Raw Normal View History

# Home-Manager Module {#ch-hm-module}
2023-06-06 02:01:44 +02:00
The home-manager module allows us to customize the different `vim` options from
inside the home-manager configuration without having to call for the wrapper
yourself. It is the recommended way to use **nvf** alongside the NixOS module
depending on your needs.
To use it, we first add the input flake.
2023-06-06 02:01:44 +02:00
2023-12-09 20:03:58 +01:00
```nix
2023-06-06 02:01:44 +02:00
{
inputs = {
obsidian-nvim.url = "github:epwalsh/obsidian.nvim";
nvf = {
url = "github:notashelf/nvf";
# you can override input nixpkgs
inputs.nixpkgs.follows = "nixpkgs";
# you can also override individual plugins
# for example:
inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
};
2023-06-06 02:01:44 +02:00
};
}
2023-12-09 20:03:58 +01:00
```
2023-06-06 02:01:44 +02:00
Followed by importing the home-manager module somewhere in your configuration.
2023-12-09 20:03:58 +01:00
```nix
{
# assuming nvf is in your inputs and inputs is in the argset
# see example below
imports = [ inputs.nvf.homeManagerModules.default ];
}
2023-12-09 20:03:58 +01:00
```
## Example Installation {#sec-example-installation-hm}
2023-06-06 02:01:44 +02:00
2023-12-09 20:03:58 +01:00
```nix
2023-06-06 02:01:44 +02:00
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
home-manager.url = "github:nix-community/home-manager";
nvf.url = "github:notashelf/nvf";
};
outputs = { nixpkgs, home-manager, nvf, ... }: let
system = "x86_64-linux"; in {
# ↓ this is your home output in the flake schema, expected by home-manager
"your-username@your-hostname" = home-manager.lib.homeManagerConfiguration
modules = [
nvf.homeManagerModules.default # <- this imports the home-manager module that provides the options
./home.nix # <- your home entrypoint
];
};
};
2023-06-06 02:01:44 +02:00
}
2023-12-09 20:03:58 +01:00
```
2023-06-06 02:01:44 +02:00
Once the module is properly imported by your host, you will be able to use the
`programs.nvf` module option anywhere in your configuration in order to
configure **nvf**.
2023-06-06 02:01:44 +02:00
2023-12-09 20:03:58 +01:00
```nix{
programs.nvf = {
2023-06-06 02:01:44 +02:00
enable = true;
# your settings need to go into the settings attribute set
# most settings are documented in the appendix
2023-06-06 02:01:44 +02:00
settings = {
vim.viAlias = false;
vim.vimAlias = true;
vim.lsp = {
enable = true;
};
};
};
}
2023-12-09 20:03:58 +01:00
```
2023-06-06 02:01:44 +02:00
::: {.note}
**nvf** exposes a lot of options, most of which are not referenced in the
installation sections of the manual. You may find all avaliable options
in the [appendix](https://notashelf.github.io/nvf/options)
2023-12-09 20:03:58 +01:00
:::