Add to footer for side-wide llms.txt

Author: sarahsanders-docker

hugo.yaml

@@ -81,6 +81,13 @@ outputFormats:
     isPlainText: true
     isHTML: false
     permalinkable: true
+  # llms.txt
+  llms:
+    baseName: llms
+    isPlainText: true
+    mediaType: "text/plain"
+    notAlternative: true
+    permalinkable: false
 
 # Enable custom output formats
 # (only generate the custom output files once)
@@ -90,6 +97,7 @@ outputs:
     - redirects
     - metadata
     - robots
+    - llms
   page:
     - html
     - Markdown

layouts/_default/index.llms.txt

@@ -0,0 +1,11 @@
+{{- $pages := .Site.RegularPages -}}
+{{- $sorted := sort $pages "RelPermalink" -}}
+{{- $grouped := $sorted.GroupBy "Section" -}}
+
+# Docker Documentation
+
+{{ range $grouped }}
+## {{ humanize .Key }}
+{{ range .Pages }}
+- [{{ .Title }}]({{ .Permalink }}){{ end }}
+{{ end -}}

layouts/partials/footer.html

@@ -10,6 +10,7 @@
       {{- with .GetPage "/contribute" }}
         <a class="underline-offset-2 hover:underline" href="{{ .Permalink }}">{{ .LinkTitle }}</a>
       {{- end }}
+      <a href="{{ "llms.txt" | relURL }}">Read llms.txt</a>
     </div>
     <hr class="text-divider-light dark:text-divider-dark" />
     <div class="grid lg:grid-cols-3 place-items-center gap-8 grid-cols-1">