https://github.com/yash-garg/neovim

My customized version of Neovim, built with Nix.
https://github.com/yash-garg/neovim

neovim nix nix-flake nixvim

Last synced: 8 months ago
JSON representation

My customized version of Neovim, built with Nix.

• Host: GitHub
• URL: https://github.com/yash-garg/neovim
• Owner: Yash-Garg
• License: apache-2.0
• Created: 2024-08-19T18:09:39.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-02T03:36:44.000Z (over 1 year ago)
• Last Synced: 2025-02-04T03:28:35.671Z (over 1 year ago)
• Topics: neovim, nix, nix-flake, nixvim
• Language: Nix
• Homepage: https://github.com/nix-community/nixvim
• Size: 139 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Neovim

[![FlakeHub](https://img.shields.io/endpoint?url=https://flakehub.com/f/Yash-Garg/neovim/badge)](https://flakehub.com/flake/Yash-Garg/neovim) [![Nix](https://img.shields.io/badge/Nix-5277C3.svg?&logo=NixOS&logoColor=white)](#)

Customized Neovim configuration ready to be used with Nix.

![Neovim Preview](https://yashgarg.dev/uses/neovim.webp)

## Try Without Installing

You can try this configuration out without committing to installing it on your system by running

the following command.

```nix

nix run github:yash-garg/neovim

```

## Install

### Nix Profile

You can install this package imperatively with the following command.

```nix

nix profile install github:yash-garg/neovim

```

### Nix Configuration

You can install this package by adding it as an input to your Nix flake.

```nix

{

  description = "My system flake";

  inputs = {

    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";

    # Snowfall is not required, but will make configuration easier for you.

    snowfall-lib = {

      url = "github:snowfallorg/lib";

      inputs.nixpkgs.follows = "nixpkgs";

    };

    neovim = {

      url = "github:yash-garg/neovim";

      # You can also use the flakehub source

      url = "https://flakehub.com/f/Yash-Garg/neovim/*.tar.gz";

      # This flake currently requires changes that are only on the Unstable channel.

      inputs.nixpkgs.follows = "nixpkgs";

    };

  };

  outputs =

    inputs:

    inputs.snowfall-lib.mkFlake {

      inherit inputs;

      src = ./.;

      overlays = with inputs; [

        # Use the overlay provided by this flake.

        neovim.overlays.default

        # There is also a named overlay, though the output is the same.

        neovim.overlays."package/neovim"

      ];

    };

}

```

If you've added the overlay from this flake, then in your system configuration

you can add the `dots.neovim` package.

```nix

{ pkgs }:

{

  environment.systemPackages = [ pkgs.dots.neovim ];

}

```