feat: add LLM-friendly Markdown output and llms.txt for every page

hugo.toml

@@ -96,11 +96,29 @@ description = "Product Documentation"
     # guessSyntax = "true"
 
 # Everything below this are Site Params
-
+[mediaTypes]
+  [mediaTypes."text/markdown"]
+    suffixes = ["md"]
+
+[outputFormats]
+  [outputFormats.markdown]
+    name = "markdown"
+    mediaType = "text/markdown"
+    baseName = "index"
+    isPlainText = true
+    notAlternative = false
+  [outputFormats.llms]
+    name = "llms"
+    mediaType = "text/plain"
+    baseName = "llms"
+    isPlainText = true
+    notAlternative = true
+
 # Comment out if you don't want the "print entire section" link enabled.
 [outputs]
-  home = ["HTML", "RSS", "SITEMAP"]
-  section = ["HTML", "RSS"]
+  home = ["HTML", "RSS", "SITEMAP", "markdown", "llms"]
+  page = ["HTML", "markdown"]
+  section = ["HTML", "RSS", "markdown"]
   taxonomy = ["HTML", "RSS"]
   term = ["HTML", "RSS"]
 

layouts/_default/list.md

@@ -0,0 +1,8 @@
+# {{ .Title }}
+{{ with .Description }}
+> {{ . }}
+{{ end }}
+{{ .RawContent }}
+{{ range .Pages }}
+- [{{ .Title }}]({{ with .OutputFormats.Get "markdown" }}{{ .RelPermalink }}{{ end }}){{ with .Description }}: {{ . }}{{ end }}
+{{- end -}}

layouts/_default/single.md

@@ -0,0 +1,5 @@
+# {{ .Title }}
+{{ with .Description }}
+> {{ . }}
+{{ end }}
+{{ .RawContent -}}

layouts/index.llms.txt

@@ -0,0 +1,9 @@
+# {{ .Site.Title }}
+
+> {{ with .Site.Home.Description }}{{ . }}{{ else }}Layer5 product documentation.{{ end }}
+
+## Docs
+
+{{ range .Site.RegularPages -}}
+- [{{ .Title }}]({{ with .OutputFormats.Get "markdown" }}{{ .Permalink }}{{ end }}){{ with .Description }}: {{ . }}{{ end }}
+{{ end -}}

layouts/partials/footer.html

@@ -20,7 +20,9 @@
   </div>
   <div class="footer-info">
     <div class="col-lg-3 footer-desc">
-      <p>Layer5 empowers engineers to build better, together. As the stewards of Meshery, and the creators of Kanvas, we deliver a Google Workspace-like experience for your infrastructure. From infrastructure as design to confident deployment, we simplify cloud management through real-time collaboration and orchestratable diagrams.</p>
+      <p>Layer5 empowers engineers to build better, together. As the stewards of Meshery, and the creators of Kanvas, we
+        deliver a Google Workspace-like experience for your infrastructure. From infrastructure as design to confident
+        deployment, we simplify cloud management through real-time collaboration and orchestratable diagrams.</p>
     </div>
 
     <div class="col-lg-9">
@@ -66,7 +68,8 @@ <h5 class="footer-h5"><a href="{{ .url }}">{{ .name }}</a></h5>
               <p>
                 Subscribe to our Newsletter
               </p>
-              <input class="footer-input" type="email" id="footer-email" name="email" placeholder="Email Address" aria-label="Email Address">
+              <input class="footer-input" type="email" id="footer-email" name="email" placeholder="Email Address"
+                aria-label="Email Address">
               <button class="footer-button" title="Subscribe" type="submit">Subscribe</button>
             </div>
           </form>
@@ -85,8 +88,13 @@ <h5 class="footer-h5"><a href="{{ .url }}">{{ .name }}</a></h5>
       <span>
         <span class="edit-page">
           {{ with .File }}
-          <a href="https://github.com/layer5io/docs/tree/master{{ strings.TrimPrefix hugo.WorkingDir .Filename }}" target="_blank"
-            rel="noreferrer">Edit This Page</a>
+          <a href="https://github.com/layer5io/docs/tree/master{{ strings.TrimPrefix hugo.WorkingDir .Filename }}"
+            target="_blank" rel="noreferrer">Edit This Page</a>
+          {{ end }}
+        </span>
+        <span class="view-markdown">
+          {{ with .OutputFormats.Get "markdown" }}
+          <a href="{{ .RelPermalink }}" target="_blank" rel="noreferrer">View as Markdown</a>
           {{ end }}
         </span>
         <span>
@@ -102,4 +110,4 @@ <h5 class="footer-h5"><a href="{{ .url }}">{{ .name }}</a></h5>
           href="https://layer5.io/company/legal/terms-of-service">Terms</a></span>
     </div>
   </div>
-</footer>
+</footer>