diff options
| author | Domen Kožar <domen@dev.si> | 2021-04-13 19:13:09 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-13 19:13:09 +0200 |
| commit | 6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4 (patch) | |
| tree | 655729e755d105449e57c339eb5237d853833850 | |
| parent | bb2dd3ea9438a0e2692f533c5a9678055d52fb6b (diff) | |
| parent | d12aba540657704a2b08ec8a1b953d9425dfe201 (diff) | |
| download | nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.tar nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.tar.gz nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.tar.bz2 nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.tar.lz nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.tar.xz nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.tar.zst nixpkgs-6f7f5bacc8ad4b8ce81508c66b76e3a96609f3f4.zip | |
Merge pull request #119277 from Pacman99/md-options
nixosOptionsDoc: add markdown formatting
| -rw-r--r-- | nixos/lib/make-options-doc/default.nix | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/nixos/lib/make-options-doc/default.nix b/nixos/lib/make-options-doc/default.nix index a1161621f0d..14015ab64ab 100644 --- a/nixos/lib/make-options-doc/default.nix +++ b/nixos/lib/make-options-doc/default.nix @@ -126,11 +126,37 @@ let } ''; + singleMDDoc = name: value: '' + ## ${lib.escape [ "<" ">" ] name} + ${value.description} + + ${lib.optionalString (value ? type) '' + *_Type_*: + ${value.type} + ''} + + ${lib.optionalString (value ? default) '' + *_Default_* + ``` + ${builtins.toJSON value.default} + ``` + ''} + + ${lib.optionalString (value ? example) '' + *_Example_* + ``` + ${builtins.toJSON value.example} + ``` + ''} + ''; + in { inherit optionsNix; optionsAsciiDoc = lib.concatStringsSep "\n" (lib.mapAttrsToList singleAsciiDoc optionsNix); + optionsMDDoc = lib.concatStringsSep "\n" (lib.mapAttrsToList singleMDDoc optionsNix); + optionsJSON = pkgs.runCommand "options.json" { meta.description = "List of NixOS options in JSON format"; buildInputs = [ pkgs.brotli ]; |