youwen5/neovim-flake
1
0
Fork 0
mirror of https://github.com/youwen5/neovim-flake.git synced 2024-11-24 19:03:49 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update readme

Browse source
This commit is contained in:
Youwen Wu 2024-09-17 16:17:40 -07:00
parent 309bc9a1eb
commit 62b25e1c4b
Signed by: youwen5
GPG key ID: 865658ED1FE61EC3
2 changed files with 29 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,12 +1,23 @@
# Neovim Configuration Flake
# viminal
This is the Neovim configuration for all my NixOS and Nix enabled systems (such
as with nix-darwin on macOS). It aims to be minimal and utilitarian; it forgoes
many blingful features like sidebars or fancy UI enhancements in favor of
native (neo)Vim, while still having everything useful you'd expect, like LSPs,
file explorer (`oil.nvim`), completions, advanced language tools, and QoL
This is the Neovim configuration for all my NixOS and Nix enabled systems
(including macOS). It aims to be minimal and utilitarian; it forgoes many
blingful features like sidebars or fancy UI enhancements in favor of native
(neo)Vim, while still having everything useful you'd expect, like LSPs, file
explorer (`oil.nvim`), completions, advanced language tools, and QoL
enhancements.
The central design goal is to prefer Vim whenever possible. The Vim text editor
is already incredibly powerful, and many plugins designed to emulate features
from more bloated editors like VS Code can already be accomplished in native
Vim. To that end, plugins were selected to unobtrusively integrate with Vim.
For instance, `oil.nvim` allows you to interface with your filesystem through a
regular Vim buffer, and Git integration is done by Gitsigns and `Neogit`, which
enable a similar interface for Git. The long-term benefit of this is avoiding
lock-in to a plugin that encourages a heavily idiosyncratic workflow which may
become unmaintained in the future, while the Neovim core itself is almost
assuredly going stick around.
It uses the [Nixvim](https://nix-community.github.io/nixvim/) project under
the hood to declaratively configure Neovim and its plugins, and installs tools
needed by it (like `ripgrep`, `fd`, etc). However, LSPs are not installed or
@ -36,7 +47,7 @@ showing me how to build a Nixvim configuration as a standalone Nix package.
You can test drive my config in just one line (if you have Nix, of course):
```sh
nix run 'github:youwen5/neovim-flake' --extra-experimental-features flakes --extra-experimental-features nix-command
nix run 'github:youwen5/viminal' --extra-experimental-features flakes --extra-experimental-features nix-command
```
If for some reason, you want to install it permanently, add it to your flake
@ -49,7 +60,7 @@ inputs, and install the package in the usual way:
inputs = {
# -- snip --
custom-neovim.url = "github:youwen5/neovim-flake";
viminal.url = "github:youwen5/viminal";
};
# -- snip --
};
@ -63,7 +74,7 @@ inputs, and install the package in the usual way:
{inputs, system, ...}:
{
environment.systemPackages = [
inputs.custom-neovim.packages.${system}.default
inputs.viminal.packages.${system}.default
# supported systems: x86_64-linux, aarch64-linux, x86_64-darwin, aarch64-darwin
];
}

9
config/keymaps.nix
View file

@ -168,6 +168,15 @@
desc = "Open Neogit";
};
}
{
action = ":Neogit commit<CR>";
key = "<Leader>gc";
options = {
silent = true;
noremap = true;
desc = "Open commit menu";
};
}
{
mode = "n";
key = "]c";