mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-20 16:15:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: introduce a dedicated homepage

Browse source 
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
This commit is contained in:
Matt Sturgeon 2024-10-21 18:02:37 +01:00
parent 47b563d4e1
commit 5992a22821
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 40 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/mdbook/SUMMARY.md
View file

@ -1,5 +1,7 @@
# Structure for nixvim docs
- [Home](./index.md)
# User guide
- [Installation](./user-guide/install.md)

36
docs/mdbook/index.md Normal file
View file

@ -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 <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_.

4
docs/user-guide/install.md
View file

@ -70,7 +70,7 @@ options as `programs.nixvim.<path>.<to>.<option> = <value>`.
When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for home-manager, NixOS, and nix-darwin respectively.
This is useful is you use nixvim both as part of an environment and as standalone.
If using the home-manager module, see [Home Manager Usage](./modules/hm.md) for more information.
If using the home-manager module, see [Home Manager Usage](../modules/hm.md) for more information.
### Standalone usage
@ -88,4 +88,4 @@ The nixvim derivation can then be used like any other package!
For an example, see the [nixvim standalone flake template](https://github.com/nix-community/nixvim/blob/main/templates/simple/flake.nix).
For more information see [Standalone Usage](./modules/standalone.md).
For more information see [Standalone Usage](../modules/standalone.md).