mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-11-23 13:50:44 +00:00
70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# Standalone Installation {#ch-standalone-installation}
|
|
|
|
It is possible to install nvf without depending on NixOS or Home-Manager as the
|
|
parent module system, using the `neovimConfiguration` function exposed in the
|
|
extended library. This function will take `modules` and `extraSpecialArgs` as
|
|
arguments, and return the following schema as a result.
|
|
|
|
```nix
|
|
{
|
|
options = "The options that were available to configure";
|
|
config = "The outputted configuration";
|
|
pkgs = "The package set used to evaluate the module";
|
|
neovim = "The built neovim package";
|
|
}
|
|
```
|
|
|
|
An example flake that exposes your custom Neovim configuration might look like
|
|
|
|
```nix
|
|
{
|
|
inputs = {
|
|
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
|
nvf.url = "github:notashelf/nvf";
|
|
};
|
|
|
|
outputs = {
|
|
self,
|
|
nixpkgs,
|
|
...
|
|
} @ inputs: {
|
|
packages."x86_64-linux" = let
|
|
neovimConfigured = (inputs.nvf.lib.neovimConfiguration {
|
|
inherit (nixpkgs.legacyPackages."x86_64-linux") pkgs;
|
|
modules = [{
|
|
config.vim = {
|
|
# Enable custom theming options
|
|
theme.enable = true;
|
|
|
|
# Enable Treesitter
|
|
tree-sitter.enable = true;
|
|
|
|
# Other options will go here. Refer to the config
|
|
# reference in Appendix B of the nvf manual.
|
|
# ...
|
|
};
|
|
}];
|
|
});
|
|
in {
|
|
# Set the default package to the wrapped instance of Neovim.
|
|
# This will allow running your Neovim configuration with
|
|
# `nix run` and in addition, sharing your configuration with
|
|
# other users in case your repository is public.
|
|
default = neovimConfigured.neovim;
|
|
};
|
|
};
|
|
}
|
|
```
|
|
|
|
<!-- TODO: mention the built-in flake template here when it is added -->
|
|
|
|
The above setup will allow to set up nvf as a standalone flake, which you can
|
|
build independently from your system configuration while also possibly sharing
|
|
it with others. The next two chapters will detail specific usage of such a setup
|
|
for a package output in the context of NixOS or Home-Manager installation.
|
|
|
|
```{=include=} chapters
|
|
standalone/nixos.md
|
|
standalone/home-manager.md
|
|
```
|