Merge pull request #119277 from Pacman99/md-options

nixosOptionsDoc: add markdown formatting

authored by

Domen Kožar and committed by
GitHub
6f7f5bac bb2dd3ea

+26
+26
nixos/lib/make-options-doc/default.nix
··· 126 126 } 127 127 ''; 128 128 129 + singleMDDoc = name: value: '' 130 + ## ${lib.escape [ "<" ">" ] name} 131 + ${value.description} 132 + 133 + ${lib.optionalString (value ? type) '' 134 + *_Type_*: 135 + ${value.type} 136 + ''} 137 + 138 + ${lib.optionalString (value ? default) '' 139 + *_Default_* 140 + ``` 141 + ${builtins.toJSON value.default} 142 + ``` 143 + ''} 144 + 145 + ${lib.optionalString (value ? example) '' 146 + *_Example_* 147 + ``` 148 + ${builtins.toJSON value.example} 149 + ``` 150 + ''} 151 + ''; 152 + 129 153 in { 130 154 inherit optionsNix; 131 155 132 156 optionsAsciiDoc = lib.concatStringsSep "\n" (lib.mapAttrsToList singleAsciiDoc optionsNix); 157 + 158 + optionsMDDoc = lib.concatStringsSep "\n" (lib.mapAttrsToList singleMDDoc optionsNix); 133 159 134 160 optionsJSON = pkgs.runCommand "options.json" 135 161 { meta.description = "List of NixOS options in JSON format";