search

nix-community / nixvim

Configure Neovim with Nix! [maintainer=@GaetanLepage, @traxys, @mattsturgeon, @khaneliman]
https://nix-community.github.io/nixvim
MIT License
1.58k stars 246 forks source link

docs: support other branches #1223

Open wikiker opened 6 months ago

wikiker commented 6 months ago

Currently only master branch is documented on https://nix-community.github.io/nixvim/ But this won't correspond to other branches: e.g. during yesterday nvim-cmp changed to cmp (and its options changed too), so now nvim-cmp options must be view upon through someting like wayback machine.

clemenscodes commented 4 months ago

Versioned docs would be great. So far only reading the source is viable for anything but latest.

arunoruto commented 4 months ago

It would be beneficial to have the docs of previous Nixvim versions. I am not sure how, or even if, it would be done using the current docs generator, but an example of how it is nicely done is the docs of numba. We can just select what version should be used!

Maybe the docs need to be switched to a different "backend"?

An alternative is to highlight this problem in the readme or even in the docs under FAQ and give a workaround like building the docs locally, as explained here. One can then display the docs using an HTTP server like simple-http-server:

simple-http-server ./result/share/doc/ # the `result` link/folder appears after the build command