diff --git a/docs/mdbook/SUMMARY.md b/docs/mdbook/SUMMARY.md index 67fbff88..4dc6b76d 100644 --- a/docs/mdbook/SUMMARY.md +++ b/docs/mdbook/SUMMARY.md @@ -1,5 +1,7 @@ # Structure for nixvim docs +- [Home](./index.md) + # User guide - [Installation](./user-guide/install.md) diff --git a/docs/mdbook/index.md b/docs/mdbook/index.md new file mode 100644 index 00000000..45847700 --- /dev/null +++ b/docs/mdbook/index.md @@ -0,0 +1,36 @@ +# 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 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_. + diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md index c96b41a0..db099b08 100644 --- a/docs/user-guide/install.md +++ b/docs/user-guide/install.md @@ -70,7 +70,7 @@ options as `programs.nixvim...