https://github.com/avimitin/nvim
Handy, maintainable, multi-languages supported neovim configuration.
https://github.com/avimitin/nvim
dotfile dotfiles editor ide linux lua neovim neovim-config nvim nvim-cmp nvim-config telescope vim vimrc vscode
Last synced: 3 months ago
JSON representation
Handy, maintainable, multi-languages supported neovim configuration.
- Host: GitHub
- URL: https://github.com/avimitin/nvim
- Owner: Avimitin
- License: apache-2.0
- Created: 2021-01-22T11:44:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-06-27T04:39:10.000Z (3 months ago)
- Last Synced: 2025-06-28T12:12:12.632Z (3 months ago)
- Topics: dotfile, dotfiles, editor, ide, linux, lua, neovim, neovim-config, nvim, nvim-cmp, nvim-config, telescope, vim, vimrc, vscode
- Language: Lua
- Homepage:
- Size: 21.1 MB
- Stars: 271
- Watchers: 7
- Forks: 48
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neovim Configuration
This Neovim configuration is built with a focus on a simple, elegant, and
distraction-free user interface. The goal is to enhance coding usability rather
than overwhelm with fancy, unnecessary UI elements. I will consistently add and
test plugins with multiple coding scenario, keep only those are suitable for
daily use.
- Clean & Minimalist Aesthetic: Enjoy a calm, focused coding environment that
prioritizes what matters most: your code.
- Streamlined Workflow: Optimized for efficiency, allowing you to code faster
and with less friction.
- Essential Tooling: Includes carefully selected plugins and settings that
genuinely improve the coding experience without adding clutter.
- Performance-Oriented: Lightweight and responsive, ensuring a smooth
experience even with larger projects.
- Focus on Readability: UI elements are designed to be clear and unobtrusive,
making your code the star of the show.
- Usability First: Every feature and plugin is chosen with practical coding
benefits in mind, not just for visual appeal.
## Getting Start
This configuration is compatible with neovim 0.10+ version.
```bash
git clone --depth=1 https://github.com/Avimitin/nvim.git ~/.config/nvim
```
Finally, input `nvim` to open the editor, and all plugins will be downloaded automatically.
```bash
nvim
```
### Nix nerds
To use this in your home-manager, you can use the `xdg.configFile` attribute:
```nix
{ pkgs }:
{
xdg.configFile = {
neovim = {
target = "nvim";
source = pkgs.fetchFromGitHub {
repo = "nvim";
owner = "Avimitin";
rev = "...";
hash = "...";
}
};
};
}
```
Diagnostic error/warning/hint are highlighted with undercurl, please use
[kitty](https://sw.kovidgoyal.net/kitty/),
[wezterm](https://wezfurlong.org/wezterm/index.html)
or anyother terminal that support undercurl.
If you are using tmux, to have a correct display, you can try my configuration below:
```tmux
# (MUST) Enable 256 color for tmux
set -g default-terminal "tmux-256color"
# (Optional, choose any of them)
# Enable true color and undercurl for wezterm
set -as terminal-features ",wezterm*:RGB"
set -as terminal-features ",wezterm*:usstyle"
# Same as above, but for kitty. (kitty doesn't support Windows so I have to keep two configuration here)
set -as terminal-features ",kitty*:RGB"
set -as terminal-features ",kitty*:usstyle"
# Same as above, but for SSH. This is useful because I am using `alias ssh="TERM=xterm-256color exec ssh"`
set -as terminal-features ",xterm-256color*:RGB"
set -as terminal-features ",xterm-256color*:usstyle"
set -as terminal-overrides ",xterm*:Tc"
# (MUST) This hijack the neovim undercurl char sequence, to avoid tmux escape them.
set -as terminal-overrides ',*:Smulx=\E[4::%p1%dm'
```
## Project Structure
- `after/ftplugin/.lua`: missing default configuration for filetypes
- `lua`: the configuration core
* `key-mapping.lua`: my modification to the built-in key mappings
* `pack.lua`: script to download lazy.nvim plugin manager
* `core/`: my modification to the built-in options and auto commands
* `completion/`: plugins and configuration for LSP and vim command completion
* `git/`: plugin and configuration for using git in Neovim
* `lang/`: plugins and configuration for using LSP server and get diagnostic in Neovim
* `libs/`: functions that I don't want to write twice
* `tools/`: miscellaneous plugins that can enhance editing experience
* `treesitter/`: plugins for text object highlight and editing
* `ui/`: plugins for decorating the neovim
- `ftdetect`: List of script to help neovim identify filetype for some file, not important.
- `indent`: List of script to help neovim properly set indentation, not important.
- `syntax`: Additional syntax detection for some file type, not important.
## Treesitter parsers in nix
- For normal user: make sure gcc is installed, then run `:TSInstall ` to compile and install corresponding treesitter plugin
- For nix user: you can add this repository as an overlay and use the pre-bundled neovim:
```nix
# flake.nix
{
description = "Simple home-manager neovim configuration";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
my-neovim.url = "github:Avimitin/nvim";
home-manager = {
url = "github:nix-community/home-manager";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = { self, nixpkgs, flake-utils, home-manager, my-neovim }: {
homeConfiguration = home-manager.lib.homeManagerConfiguration {
# import my overlay, it will add a new `neovim-nightly` derivation into your nixpkgs
pkgs = import nixpkgs { system = "x86_64-linux"; overlays = [ my-neovim.overlays.default ]; };
modules = [
({ pkgs }: {
# Then add the pre-bundled neovim into your home configuration
home.packages = [
pkgs.neovim-nightly
];
})
];
};
};
}
```
## License
This configuration since commit `912416ae9c4b55501b23a91d774b567ba8697dd1` are
licenced under the Apache 2.0 license.
另附：禁止在 CSDN，bilibili 等国内平台使用该配置文件进行任何活动。
你只保有自己修改部分的权利。
# Additional notes
## About treesitter bumping
- Run `:Lazy sync`
- Remove hash in ./nix/nvim-treesitter-lock-file.nix
- Run `nix build '.#neovim-nightly'`
- Update hash
- Run `./bump_treesitter.hs`
- Run `nix build '.#neovim-nightly'`