elythh/nixvim

github github
neovimnixnixvimvim
stars 99
issues 0
subscribers 2
forks 29
CREATED

2024-02-03

UPDATED

14 days ago


Nixvim config

My Neovim config using nixvim.

Configuring

To start configuring, just add or modify the nix files in ./config. If you add a new configuration file, remember to add it to the config/default.nix file

Current plugins

Testing your new configuration

To test your configuration simply run the following command

nix run .

If you have nix installed, you can directly run my config from anywhere

You can try running mine with:

nix run 'github:elythh/nixvim'

Installing into NixOS configuration

This nixvim flake will output a derivation that you can easily include in either home.packages for home-manager, or environment.systemPackages for NixOS. Or whatever happens with darwin?

You can add my nixvim configuration as an input to your NixOS configuration like:

{
 inputs = {
    nixvim.url = "github:elythh/nixvim";
 };
}

Direct installation

With the input added you can reference it directly.

{ inputs, system, ... }:
{
  # NixOS
  environment.systemPackages = [ inputs.nixvim.packages.${pkgs.system}.default ];
  # home-manager
  home.packages = [ inputs.nixvim.packages.${pkgs.system}.default ];
}

The binary built by nixvim is already named as nvim so you can call it just like you normally would.

Installing as an overlay

Another method is to overlay your custom build over neovim from nixpkgs.

This method is less straight-forward but allows you to install neovim like you normally would. With this method you would just install neovim in your configuration (home.packges = with pkgs; [ neovim ]), but you replace neovim in pkgs with your derivation from nixvim.

{
  pkgs = import inputs.nixpkgs {
    overlays = [
      (final: prev: {
        neovim = inputs.nixvim.packages.${pkgs.system}.default;
      })
    ];
  }
}

Bonus lazy method

You can just straight up alias something like nix run 'github:elythh/nixvim' to nvim.

Bonus extend method

If you want to extend this config is your own NixOS config, you can do so using nixvimExtend. See here for more info.

Example for overwritting the theme

{
  inputs,
  lib,
  ...
}: let
  nixvim' = inputs.nixvim.packages."x86_64-linux".default;
  nvim = nixvim'.nixvimExtend {
    config.theme = lib.mkForce "jellybeans";
  };
in {
  home.packages = [
    nvim
  ];
}

Credits