Merge pull request #41 from roidelapluie/toolsdesc

Add tools description to the home page

cmd/oy-periodic-queries/README.md

@@ -1,6 +1,6 @@
-# oy-periodic-rules
+# oy-periodic-queries
 
-*oy-periodic-rules* is a tool that allows you to evaluate Prometheus
+*oy-periodic-queries* is a tool that allows you to evaluate Prometheus
 recording rules and export the results as metrics, with defined boundaries such
 as monthly or weekly (*Only monthly is implemented at the moment*).
 

docs/layouts/shortcodes/tools.html

@@ -1,5 +1,5 @@
 <ul>
     {{ range where .Site.RegularPages "Params.Tool" "!=" nil }}
-    <li><a href="{{ .Permalink }}">{{ .Params.Tool }}</a></li>
+    <li><strong><a href="{{ .Permalink }}">{{ .Params.Tool }}</a></strong> {{ .Params.Description  | markdownify }}</li>
     {{ end }}
 </ul>

tool-documentation.nix

@@ -7,13 +7,17 @@
   usage = pkgs.runCommand "${name} --help" {} "${tool}/bin/${name} --help &> $out";
   documentation = pkgs.writeTextFile {
     name = "${name}-doc.md";
-    text = ''
+    text = let
+      firstParagraphDescription = builtins.elemAt (builtins.split "\n\n" (builtins.readFile description)) 0;
+      frontmatterDescription = pkgs.lib.removePrefix "\n*${name}*" firstParagraphDescription;
+    in ''
       ---
       title: ${name}
       geekdocRepo: "https://github.com/o11ydev/oy-toolkit"
       geekdocEditPath: "edit/main/cmd/${name}"
       geekdocFilePath: "README.md"
       tool: ${name}
+      description: ${assert frontmatterDescription != firstParagraphDescription; builtins.toJSON frontmatterDescription}
       ---
 
       ${builtins.readFile ./docs/tools-top.md}