about summary refs log tree commit diff
path: root/nixpkgs/doc/build-aux/pandoc-filters/link-manpages.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixpkgs/doc/build-aux/pandoc-filters/link-manpages.nix')
-rw-r--r--nixpkgs/doc/build-aux/pandoc-filters/link-manpages.nix28
1 files changed, 28 insertions, 0 deletions
diff --git a/nixpkgs/doc/build-aux/pandoc-filters/link-manpages.nix b/nixpkgs/doc/build-aux/pandoc-filters/link-manpages.nix
new file mode 100644
index 000000000000..2589a7c34251
--- /dev/null
+++ b/nixpkgs/doc/build-aux/pandoc-filters/link-manpages.nix
@@ -0,0 +1,28 @@
+{ pkgs ? import ../../.. {} }:
+let
+  inherit (pkgs) lib;
+  manpageURLs = lib.importJSON (pkgs.path + "/doc/manpage-urls.json");
+in pkgs.writeText "link-manpages.lua" ''
+  --[[
+  Adds links to known man pages that aren't already in a link.
+  ]]
+
+  local manpage_urls = {
+  ${lib.concatStringsSep "\n" (lib.mapAttrsToList (man: url:
+    "  [${builtins.toJSON man}] = ${builtins.toJSON url},") manpageURLs)}
+  }
+
+  traverse = 'topdown'
+
+  -- Returning false as the second value aborts processing of child elements.
+  function Link(elem)
+    return elem, false
+  end
+
+  function Code(elem)
+    local is_man_role = elem.classes:includes('interpreted-text') and elem.attributes['role'] == 'manpage'
+    if is_man_role and manpage_urls[elem.text] ~= nil then
+      return pandoc.Link(elem, manpage_urls[elem.text]), false
+    end
+  end
+''