Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elythh/nixvim

❄️ my neovim config using nixvim
https://github.com/elythh/nixvim

neovim nix nixvim vim

Last synced: 2 months ago
JSON representation

❄️ my neovim config using nixvim

Awesome Lists containing this project

README 

        


    neovim-flake Logo




# Nixvim config



My Neovim config using nixvim.



nvim



    More!

    nvim

    nvim



## 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`](../config/default.nix) file



### Current plugins



- **[colorscheme/](../config/plug/colorscheme):** Theme configuration. Current one is [paradise](https://github.com/paradise-theme/paradise)

- **[completion/](../config/plug/completion)**

  - **[nvim-cmp](../config/plug/completion/cmp.nix):** Completion plugin for nvim + emoji support

  - **[copilot-cmp](../config/plug/completion/copilot-cmp.nix):** Completion support for GitHub copilot

  - **[lspkind](../config/plug/completion/lspkind.nix):** vscode-like pictograms for neovim lsp completion items

  - **[schemastore.nvim](../config/plug/completion/schemastore.nix):** Schemastore integration

- **[git/](../config/plug/git)**

  - **[gitlinker](../config/plug/git/gitlinker.nix):** Generate shareable file permalinks

  - **[gitsigns](../config/plug/git/gitsigns.nix):** Git integration for buffers

  - **[lazygit](../config/plug/git/lazygit.nix):** The **best** git TUI, as a neovim plugin

  - **[worktree](../config/plug/git/worktree.nix):** Make using git worktrees easier

- **[lsp/](../config/plug/lsp)**

  - **[conform](../config/plug/lsp/conform.nix):** Formatter plugin

  - **[fidget](../config/plug/lsp/fidget.nix):** LSP progress notifications

  - **[hlchunk](../config/plug/lsp/hlchunk.nix):** Highlight useful things like current chunk or indent lines

  - **[lsp](../config/plug/lsp/lsp.nix):** LSP configs

  - **[lspsaga](../config/plug/lsp/lspsaga.nix):** Cool LSP features

  - **[none-ls](../config/plug/lsp/none-ls.nix):** null-ls replacement. Use nvim as LSP

  - **[trouble](../config/plug/lsp/trouble.nix):** Pretty interface for working with LSP

- **[snippet/](../config/plug/snippet)**

  - **[luasnip](../config/plug/snippet/luasnip.nix):** Snippet engine in lua

- **[statusline/](../config/plug/statusline)**

  - **[lualine](../config/plug/statusline/lualine.nix):** Status line for neovim

  - **[staline](../config/plug/statusline/staline.nix):** Some soviet guy that died a long time ago

- **[treesitter/](../config/plug/treesitter)**

  - **[treesitter-context](../config/plug/treesitter/treesitter-context.nix):** Show code context

  - **[treesitter-textobject](../config/plug/treesitter/treesitter-textobject.nix):** Allow cool text manupulation thanks to TS

  - **[treesitter](../config/plug/treesitter/treesitter.nix):** Parser generator tool to build a syntax tree of the current buffer

- **[ui/](../config/plug/ui)**

  - **[alpha](../config/plug/ui/alpha.nix):** Dashboard

  - **[btw](../config/plug/ui/btw.nix):** Writes a small message as startup screen

  - **[bufferline](../config/plug/ui/bufferline.nix):** VSCode like line for buffers

  - **[noice](../config/plug/ui/noice.nix):** Better nvim UI

  - **[nvim-notify](../config/plug/ui/nvim-notify.nix):** Notification manager

  - **[precognition](../config/plug/ui/precognition.nix):** Show inline navigation hint

  - **[telescope](../config/plug/ui/telescope.nix):** Best plugin ever ?

- **[utils/](../config/plug/utils)**

  - **[comment](../config/plug/utils/comment.nix):** Quickly toggle comments

  - **[CopilotChat](../config/plug/utils/copilot.nix):** Chat with copilot in nvim

  - **[flash](../config/plug/utils/flash.nix):** Navigate in file with a few keystrokes

  - **[grapple](../config/plug/utils/grapple.nix):** Quickly switch between buffers (Harpoon replacement)

  - **[hardtime](../config/plug/utils/hardtime.nix):** Learn vim motions, the hard way

  - **[harpoon](../config/plug/utils/harpoon.nix):** Quickly switch between buffers

  - **[illuminate](../config/plug/utils/illuminate.nix):** Highlight word under the cursor

  - **[markview](../config/plug/utils/markview.nix):** Yet another markdown previewer for neovim

  - **[mini](../config/plug/utils/mini.nix):** Cool neovim utilities

  - **[nvim-autopairs](../config/plug/utils/nvim-autopairs.nix):** Autopairs in nvim

  - **[obsidian](../config/plug/utils/obsidian.nix):** Obsidian integration for nvim

  - **[oil](../config/plug/utils/oil.nix):** Navigate in your working folder with a buffer

  - **[ufo](../config/plug/utils/ufo.nix):** Folding plugin

  - **[undotree](../config/plug/utils/undotree.nix):** Undo history visualizer

  - **[whichkey](../config/plug/utils/whichkey.nix):** Popup to display keybindings



## 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:



```shell

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:



```nix

{

 inputs = {

    nixvim.url = "github:elythh/nixvim";

 };

}

```



### Direct installation



With the input added you can reference it directly.



```nix

{ 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`.



```nix

{

  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](https://nix-community.github.io/nixvim/modules/standalone.html) for more info.



Example for overwritting the theme



```nix

{

  inputs,

  lib,

  ...

}: let

  nixvim' = inputs.nixvim.packages."x86_64-linux".default;

  nvim = nixvim'.nixvimExtend {

    config.theme = lib.mkForce "jellybeans";

  };

in {

  home.packages = [

    nvim

  ];

}

```



## Credits



- [yavko](https://github.com/yavko) for the logo