docs: use nixosOptionDocs

[NotAShelf]

NixOS 23.11 is deprecating DocBook option documentation. Following home-manager in this change is probably a good idea. This change drops literalDocBook and the provided nmd functions in favor of nixosOptionDocs and CommonMark in option descriptions.

[NotAShelf]

@horriblename building options.json currently fails with option vim.extraPlugins.<name>.package has no description, any chance you could look at this?

[horriblename]

oops missing description

diff --git a/lib/types/plugins.nix b/lib/types/plugins.nix
index 344c405..ee33a42 100644
--- a/lib/types/plugins.nix
+++ b/lib/types/plugins.nix
@@ -112,6 +112,7 @@ with lib; let
       options = {
         package = mkOption {
           type = pluginType;
+          description = "Plugin Package.";
         };
         after = mkOption {
           type = listOf str;

build still not passing tho, this time failing on

       > /nix/store/q53bq2b1dw0wa75znak2sxi1p5rxkl5g-manual-combined/manual-combined.xml:7
45: element appendix: Relax-NG validity error : Element appendix failed to validate conten
t
       >    741   </section>
       >    742      </chapter>
       >    743       <appendix xml:id="ch-options">
       >    744   <title>Configuration Options</title>
       >    745    <appendix xmlns="http://docbook.org/ns/docbook" xml:id="appendix-config
uration-options" xml:base="nmd-result/neovim-flake-options.xml">
       >    746         <title>Configuration Options</title>
       >    747  <variablelist xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:nixos="tag
:nixos.org" xmlns="http://docbook.org/ns/docbook" xml:id="neovim-flake-options">
       >
       > /nix/store/q53bq2b1dw0wa75znak2sxi1p5rxkl5g-manual-combined/manual-combined.xml f
ails to validate

do you know what's going on?

[NotAShelf]

I might have an idea, I'll see if that helps

[NotAShelf]

neat, that did the trick

[horriblename]

{option} don't provide links in the html docs.

i.e.

If vim.lsp.lspkind.enable is true, then the function will be called before modifications from lspkind.

instead of

If vim.lsp.lspkind.enable is true, then the function will be called before modifications from lspkind.

[NotAShelf]

that is interesting, we're basically following home-manager in regards of nmd usage - but features that it's able to use don't apply to us, which seems to be all CommonMark features?

[NotAShelf]

after little research, I've noticed that {option} intentionally does not link the relevant issue. Home-manager seems to be using [](#opt-home...) for linked options.

[NotAShelf]

Okay, I believe 9328443 remedies the issue you've mentioned. The only remaining issue is the codeblock not being converted correctly in autocomplete.formatting.format

[NotAShelf]

Might be because it's an example?

[horriblename]

lib.literalMD seems to work

[horriblename]

LGTM