mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

contributing: add note on testing the docs

Browse source
This commit is contained in:
Matt Sturgeon 2025-05-22 13:56:18 +01:00
parent 1ff5e1a33b
commit e385bec735
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -13,6 +13,14 @@ In order to submit a change you must be careful of several points:
- The commit title should be consistent with our style. This usually looks like "plugins/<name>: fixed some bug",
you can browse the commit history of the files you're editing to see previous commit messages.
### Testing the docs locally
When making a change, you may wish to see how it looks in Nixvim's documentation.
This can be done by running `nix run .#docs` from within a Nixvim repo.
Alternatively, if you've entered a Nixvim dev shell, you can run `serve-docs`.
Either command will start a HTTP server on port 8000 and open it in your browser using `xdg-open`.
## Nixvim Architecture
Nixvim is mainly built around `pkgs.neovimUtils.makeNeovimConfig`.