add llms.txt to repo

Author: sarahsanders-docker

hugo.yaml

@@ -74,15 +74,24 @@ outputFormats:
     isPlainText: true
     mediaType: "text/plain"
     notAlternative: true
+  # llms.txt, see layouts/single.llmstxt.txt
+  llmstxt:
+    baseName: llms
+    mediaType: "text/plain"
+    isPlainText: true
+    notAlternative: true
 
-# Enable custom output formats for the home page only
+# Enable custom output formats
 # (only generate the custom output files once)
 outputs:
   home:
     - html
     - redirects
     - metadata
     - robots
+  page:
+    - html
+    - llmstxt
 
 languages:
   en:

hugo_stats.json

@@ -188,6 +188,7 @@
       "dark:bg-background-dark",
       "dark:bg-blue-dark",
       "dark:bg-blue-dark-400",
+      "dark:bg-gray-800",
       "dark:bg-gray-dark-100",
       "dark:bg-gray-dark-200",
       "dark:bg-gray-dark-300",
@@ -216,6 +217,7 @@
       "dark:from-blue-dark-400",
       "dark:from-gray-dark-100",
       "dark:hidden",
+      "dark:hover:bg-blue-500",
       "dark:hover:bg-blue-dark",
       "dark:hover:bg-blue-dark-500",
       "dark:hover:bg-gray-dark-200",
@@ -228,6 +230,7 @@
       "dark:text-amber-dark",
       "dark:text-blue-dark",
       "dark:text-divider-dark",
+      "dark:text-gray-400",
       "dark:text-gray-dark",
       "dark:text-gray-dark-300",
       "dark:text-gray-dark-500",
@@ -284,9 +287,11 @@
       "grid-cols-1",
       "group",
       "group-hover:block'",
+      "group-open:rotate-180",
       "h-16",
       "h-2",
       "h-32",
+      "h-4",
       "h-48",
       "h-6",
       "h-8",
@@ -298,6 +303,7 @@
       "hidden",
       "hidden'",
       "highlight",
+      "hover:bg-blue-600",
       "hover:bg-blue-light-400",
       "hover:bg-gray-light-100",
       "hover:bg-gray-light-200",
@@ -311,13 +317,15 @@
       "hover:dark:text-blue-dark",
       "hover:drop-shadow-lg",
       "hover:opacity-90",
+      "hover:text-blue-600",
       "hover:text-blue-light",
       "hover:text-white",
       "hover:underline",
       "icon-lg",
       "icon-sm",
       "icon-svg",
       "inline",
+      "inline-block",
       "inline-flex",
       "inset-0",
       "invertible",
@@ -387,6 +395,7 @@
       "mt-1",
       "mt-2",
       "mt-20",
+      "mt-3",
       "mt-4",
       "mt-8",
       "mx-auto",
@@ -410,6 +419,7 @@
       "overflow-y-auto",
       "p-1",
       "p-2",
+      "p-3",
       "p-4",
       "p-6",
       "p-8",
@@ -435,6 +445,7 @@
       "pt-4",
       "px-1",
       "px-2",
+      "px-3",
       "px-4",
       "px-6",
       "py-1",
@@ -446,15 +457,20 @@
       "right-0",
       "right-3",
       "right-8",
+      "ring-1",
       "ring-2",
       "ring-[1.5px]",
+      "ring-black",
       "ring-blue-light-400",
       "ring-gray-light-200",
+      "ring-opacity-5",
       "rotate-45",
       "rounded",
       "rounded-[6px]",
       "rounded-b-lg",
       "rounded-full",
+      "rounded-lg",
+      "rounded-md",
       "rounded-sm",
       "scale-50",
       "scale-75",
@@ -465,6 +481,7 @@
       "self-start",
       "shadow",
       "shadow-lg",
+      "shadow-sm",
       "sm:block",
       "sm:flex",
       "sm:flex-row",
@@ -473,6 +490,7 @@
       "sm:w-full",
       "space-x-2",
       "space-y-2",
+      "space-y-3",
       "space-y-4",
       "sticky",
       "svg-container",
@@ -482,8 +500,10 @@
       "text-amber-light",
       "text-base",
       "text-black",
+      "text-blue-500",
       "text-blue-light",
       "text-divider-light",
+      "text-gray-500",
       "text-gray-light",
       "text-gray-light-200",
       "text-gray-light-300",
@@ -513,11 +533,16 @@
       "top-3",
       "top-6",
       "top-full",
+      "transform",
       "transition",
+      "transition-transform",
       "truncate",
       "underline-offset-2",
       "uppercase",
       "w-2",
+      "w-4",
+      "w-64",
+      "w-72",
       "w-8",
       "w-[1200px]",
       "w-[32px]",

layouts/_default/single.llmstxt.txt

@@ -0,0 +1,3 @@
+{{ .Title }}
+
+{{ .RawContent | replaceRE `{{[%<][^>]*[%>]}}` "" }}

layouts/partials/content-default.html

@@ -8,6 +8,7 @@ <h1 data-pagefind-weight="10" class="scroll-mt-36">{{ .Title }}</h1>
       <hr />
     </div>
     {{ .Content }}
+    {{ partial "llms-dropdown.html" . }}
   </article>
   <div class="hidden flex-1 min-w-52 lg:block -mr-8 -mt-8">
     {{ partial "aside.html" . }}

layouts/partials/llms-dropdown.html

@@ -0,0 +1,61 @@
+<div class="my-4 p-4 rounded-lg bg-transparent">
+    <details class="inline-block group">
+      <summary class="inline-flex items-center gap-2 rounded bg-blue-light dark:bg-blue-dark text-white py-2 px-4 cursor-pointer font-semibold">
+        <span>Copy llms.txt file</span>
+        <svg
+          class="h-2 w-2 transform transition-transform group-open:rotate-180"
+          xmlns="http://www.w3.org/2000/svg"
+          fill="none"
+          viewBox="0 0 24 24"
+          stroke="currentColor"
+        >
+          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M19 9l-7 7-7-7" />
+        </svg>
+      </summary>
+      <div class="mt-3 space-y-4 text-sm pl-5">
+        <div>
+          <button onclick="copyMarkdown()" class="text-left text-blue-500 hover:text-blue-600 font-semibold">Copy page</button>
+          <div class="text-gray-500 dark:text-gray-400">Copy this page as Markdown for LLMs</div>
+        </div>
+        <div>
+          <button onclick="viewPlainText()" class="text-left text-blue-500 hover:text-blue-600 font-semibold">View as Markdown</button>
+          <div class="text-gray-500 dark:text-gray-400">View this page as plain text</div>
+        </div>
+        <div>
+          <button onclick="openInDocsAI()" class="text-left text-blue-500 hover:text-blue-600 font-semibold">Open in Docker Docs AI</button>
+          <div class="text-gray-500 dark:text-gray-400">Ask questions about this page with Docker Docs AI</div>
+        </div>
+      </div>
+    </details>
+  </div>
+
+  <script>
+  function getCurrentPlaintextUrl() {
+    const currentUrl = window.location.href.split('#')[0].replace(/\/$/, '');
+    return `${currentUrl}/llms.txt`;
+  }
+
+  function copyMarkdown() {
+    fetch(getCurrentPlaintextUrl())
+      .then(response => response.text())
+      .then(text => {
+        navigator.clipboard.writeText(text)
+          .then(() => alert('Markdown copied to clipboard!'))
+          .catch(err => alert('Failed to copy markdown: ', err));
+      })
+      .catch(err => alert('Error fetching markdown: ', err));
+  }
+
+  function viewPlainText() {
+    window.open(getCurrentPlaintextUrl(), '_blank');
+  }
+
+  function openInDocsAI() {
+  const kapaButton = document.querySelector('.open-kapa-widget');
+  if (kapaButton) {
+    kapaButton.click();
+  } else {
+    alert("Couldn't find the DocsAI button.");
+  }
+}
+  </script>