From e385bec735ea03d2e009cde443cf77f3d0aea40e Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Thu, 22 May 2025 13:56:18 +0100 Subject: [PATCH] contributing: add note on testing the docs --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b6fc03c..7e9da34e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/: 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`.