mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-21 16:39:00 +02:00
5992a22821
Based of the README for now, with a small additional "welcome to the docs" section. Perhaps in future, we could re-use the README.md verbatim? Perhaps with some additional post-processing. I think we'd want to dramatically reduce its size first though. By having a dedicated homepage outside of `user-guide`, this fixes #1625
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# NixVim - A Neovim configuration system for nix
|
|
|
|
## What is it?
|
|
NixVim is a [Neovim](https://neovim.io) distribution built around
|
|
[Nix](https://nixos.org) modules. It is distributed as a Nix flake, and
|
|
configured through Nix, all while leaving room for your plugins and your vimrc.
|
|
|
|
## What does it look like?
|
|
Here is a simple configuration that uses catppuccin as the colorscheme and uses the
|
|
lualine plugin:
|
|
|
|
```nix
|
|
{
|
|
programs.nixvim = {
|
|
enable = true;
|
|
|
|
colorschemes.catppuccin.enable = true;
|
|
plugins.lualine.enable = true;
|
|
};
|
|
}
|
|
```
|
|
|
|
When we do this, lualine will be set up to a sensible default, and will use
|
|
catppuccin as the colorscheme, no extra configuration required!
|
|
|
|
Check out [this list of real world nixvim configs](./user-guide/config-examples.md)!
|
|
|
|
## Welcome to the docs!
|
|
|
|
Over to the left, you'll find the sidebar. There you'll see several "User guides" (including an [FAQ](./user-guide/faq.md)]), along with pages for various "options".
|
|
|
|
While you can search our main docs using the <i class="fa fa-search"></i> icon, if you're looking for a specific option you may find the dedicated [Nixvim Option Search](./search/index.html) (at the bottom of the sidebar) has more relevant results.
|
|
|
|
> [!TIP]
|
|
> Any page with a ❱ icon next to it has one-or-more _sub-pages_.
|
|
|