feat: Added Markdown generation for markdown versions of all pages.

- updated llms.txt page buit by hugo
- added llms-full.txt

Author: gaurav-nelson

Makefile

@@ -5,7 +5,7 @@ UNAME=$(shell uname -s)
 # Also because of the proxy 127.0.0.1 doesn't work as a bind address.
 ifeq ($(UNAME), Darwin)
 	PODMAN_OPTS ?= -it --security-opt label=disable --pull=newer -p 4000:4000
-	HUGO_SERVER_OPTS = --bind 0.0.0.0 
+	HUGO_SERVER_OPTS = --bind 0.0.0.0
 else
 	PODMAN_OPTS ?= -it --security-opt label=disable --pull=newer --net=host
 endif
@@ -35,12 +35,17 @@ test: htmltest ## Runs tests
 
 .PHONY: build
 build: ## Build the website locally in the public/ folder
-	podman run $(PODMAN_OPTS) -v $(PWD):/site:$(ATTRS) --entrypoint hugo $(HOMEPAGE_CONTAINER)
+	podman run $(PODMAN_OPTS) -v $(PWD):/site:$(ATTRS) $(HOMEPAGE_CONTAINER) -c "hugo && node utils/generate-md.js"
+
+.PHONY: generate-md
+generate-md: ## Generate Markdown versions of all pages in public/
+	node utils/generate-md.js
 
 .PHONY: serve
 serve: ## Build the website locally from a container and serve it
 	@echo "Serving via container. Browse to http://localhost:4000"
-	podman run $(PODMAN_OPTS) -v $(PWD):/site:$(ATTRS) --entrypoint hugo $(HOMEPAGE_CONTAINER) server -p 4000 $(HUGO_SERVER_OPTS)
+	podman run $(PODMAN_OPTS) -v $(PWD):/site:$(ATTRS) $(HOMEPAGE_CONTAINER) -c "hugo && node utils/generate-md.js && hugo server -p 4000 $(HUGO_SERVER_OPTS)"
+
 
 .PHONY: htmltest
 htmltest: build ## Runs htmltest against the site to find broken links

config.yaml

@@ -45,6 +45,11 @@ mediaTypes:
 outputFormats:
   patterns:
     mediatype: application/json
+  llmstxt:
+    mediatype: text/plain
+    baseName: llms
+    isPlainText: true
+    notAlternative: true
 
 menus:
   main:
@@ -56,3 +61,7 @@ sitemap:
   priority: 0.5
   filename: sitemap.xml
 enableRobotsTXT: true
+outputs:
+  home:
+    - html
+    - llmstxt

layouts/index.llmstxt.txt

@@ -0,0 +1,28 @@
+# {{ .Site.Title }}
+
+> {{ .Site.Params.description }}
+
+Important notes:
+
+- Validated Patterns are built on OpenShift Container Platform (Kubernetes) and leverage GitOps principles using ArgoCD, Red Hat Advanced Cluster Management (RHACM), and Tekton
+- They are designed for IT architects, advanced developers, and system administrators familiar with Kubernetes and OpenShift
+- Patterns can be deployed using either the OpenShift-based Validated Patterns framework or the Ansible GitOps Framework (AGOF)
+- All patterns require an available OpenShift 4.12+ cluster with cluster-admin privileges, at least 8 CPU cores, 16GB RAM, and dynamic storage provisioning
+- Each pattern includes values files (values-global.yaml, values-hub.yaml) for customization and secrets management without committing sensitive data to git repositories
+- Markdown versions of all pages are available by appending index.md to any page URL. For example: https://validatedpatterns.io/learn/quickstart/index.md
+- Full documentation in a single file: https://validatedpatterns.io/llms-full.txt
+
+## Learn
+{{ range where .Site.RegularPages "Section" "learn" }}
+- [{{ .Title }}]({{ .Permalink }}): {{ with .Params.summary }}{{ . }}{{ else }}{{ .Summary | plainify | truncate 150 }}{{ end }}
+{{- end }}
+
+## Patterns
+{{ range .Site.Sections }}{{ if eq .Section "patterns" }}{{ range .Sections }}
+- [{{ .Title }}]({{ .Permalink }}): {{ with .Params.summary }}{{ . }}{{ else }}{{ .Summary | plainify | truncate 150 }}{{ end }}
+{{- end }}{{ end }}{{ end }}
+
+## Contributing
+{{ range where .Site.RegularPages "Section" "contribute" }}
+- [{{ .Title }}]({{ .Permalink }}): {{ with .Params.summary }}{{ . }}{{ else }}{{ .Summary | plainify | truncate 150 }}{{ end }}
+{{- end }}

layouts/partials/page-actions.html

@@ -1,15 +1,4 @@
-{{- $repo := .Site.Params.github_repo | default "validatedpatterns/docs" -}}
-{{- $branch := .Site.Params.github_branch | default "main" -}}
-{{- $filePath := "" -}}
-{{- $rawUrl := "" -}}
-{{- $sourceLabel := "View source" -}}
-{{- if .File -}}
-  {{- $filePath = .File.Path -}}
-  {{- $rawUrl = printf "https://raw.githubusercontent.com/%s/%s/content/%s" $repo $branch $filePath -}}
-  {{- if strings.HasSuffix $filePath ".md" -}}
-    {{- $sourceLabel = "View as Markdown" -}}
-  {{- end -}}
-{{- end -}}
+{{- $mdUrl := printf "%sindex.md" .Permalink -}}
 
 <div class="page-actions" data-permalink="{{ .Permalink }}">
   <button type="button" class="page-actions__button" data-action="copy-page" aria-label="Copy page content">
@@ -25,21 +14,19 @@
         <i class="fas fa-link" aria-hidden="true"></i> Copy link
       </button>
     </li>
-    {{- if $rawUrl }}
     <li role="menuitem">
-      <a href="{{ $rawUrl }}" target="_blank" rel="noopener">
-        <i class="fab fa-markdown" aria-hidden="true"></i> {{ $sourceLabel }}
+      <a href="{{ $mdUrl }}" target="_blank" rel="noopener">
+        <i class="fab fa-markdown" aria-hidden="true"></i> View as Markdown
       </a>
     </li>
-    {{- end }}
     <li class="page-actions__divider" role="separator"></li>
     <li role="menuitem">
-      <a href="https://claude.ai/new?q={{ printf "Read and summarize this documentation page: %s" .Permalink | urlquery }}" target="_blank" rel="noopener">
+      <a href="https://claude.ai/new?q={{ printf "Read this page from the Validated Patterns docs: %sindex.md and answer questions about the content." .Permalink | urlquery }}" target="_blank" rel="noopener">
         <i class="fas fa-robot" aria-hidden="true"></i> Open in Claude
       </a>
     </li>
     <li role="menuitem">
-      <a href="https://chatgpt.com/?q={{ printf "Read and summarize this documentation page: %s" .Permalink | urlquery }}" target="_blank" rel="noopener">
+      <a href="https://chatgpt.com/?q={{ printf "Read this page from the Validated Patterns docs: %sindex.md and answer questions about the content." .Permalink | urlquery }}" target="_blank" rel="noopener">
         <i class="fas fa-comment-dots" aria-hidden="true"></i> Open in ChatGPT
       </a>
     </li>

static/js/page-actions.js

@@ -88,11 +88,20 @@
   }
 
   function copyPageContent(triggerEl) {
-    var content = document.querySelector(".pf-c-content");
-    if (!content) return;
-
-    var text = content.innerText || content.textContent;
-    copyToClipboard(text, triggerEl);
+    var mdUrl = window.location.href.replace(/\/?$/, "/") + "index.md";
+    fetch(mdUrl)
+      .then(function (res) {
+        if (!res.ok) throw new Error("not found");
+        return res.text();
+      })
+      .then(function (text) {
+        copyToClipboard(text, triggerEl);
+      })
+      .catch(function () {
+        var content = document.querySelector(".pf-c-content");
+        if (!content) return;
+        copyToClipboard(content.innerText || content.textContent, triggerEl);
+      });
   }
 
   function copyToClipboard(text, triggerEl) {