From 5bfea67a21260f7ea298083bc11015c7208524c3 Mon Sep 17 00:00:00 2001
From: Skyler Grey <minion@freshlybakedca.ke>
Date: Sat, 20 Sep 2025 12:19:35 +0000
Subject: [PATCH] appview/pages: show README files in tree listings
Change-Id: lvyuwqkzxyzoynwvyxstruurwqvqkwmy

We have README files displayed on the main page of a repository, but we
don't do that on subfolders.

In the previous commit, we returned these from the knotserver in the
RepoTreeResponse. We now need to do something similar to what we do on
the index page on the individual tree pages...

Signed-off-by: Skyler Grey <minion@freshlybakedca.ke>
---
 appview/pages/pages.go                 | 16 +++++++++++++++
 appview/pages/templates/repo/tree.html | 27 ++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)

diff --git a/appview/pages/pages.go b/appview/pages/pages.go
index 9afd120..bfc459a 100644
--- a/appview/pages/pages.go
+++ b/appview/pages/pages.go
@@ -686,6 +686,8 @@ type RepoTreeParams struct {
 	Active       string
 	BreadCrumbs  [][]string
 	TreePath     string
+	HTMLReadme   template.HTML
+	Raw          bool
 	types.RepoTreeResponse
 }
 
@@ -712,6 +714,20 @@ func (r RepoTreeParams) TreeStats() RepoTreeStats {
 
 func (p *Pages) RepoTree(w io.Writer, params RepoTreeParams) error {
 	params.Active = "overview"
+
+	if params.ReadmeFileName != "" {
+		ext := filepath.Ext(params.ReadmeFileName)
+		switch ext {
+		case ".md", ".markdown", ".mdown", ".mkdn", ".mkd":
+			params.Raw = false
+			htmlString := p.rctx.RenderMarkdown(params.Readme)
+			sanitized := p.rctx.SanitizeDefault(htmlString)
+			params.HTMLReadme = template.HTML(sanitized)
+		default:
+			params.Raw = true
+		}
+	}
+
 	return p.executeRepo("repo/tree", w, params)
 }
 
diff --git a/appview/pages/templates/repo/tree.html b/appview/pages/templates/repo/tree.html
index 75bd7e7..664e42a 100644
--- a/appview/pages/templates/repo/tree.html
+++ b/appview/pages/templates/repo/tree.html
@@ -88,3 +88,30 @@
   </div>
 </main>
 {{end}}
+
+{{ define "repoAfter" }}
+    {{- if or .HTMLReadme .Readme -}}
+        <div class="mt-4 rounded bg-white dark:bg-gray-800 drop-shadow-sm w-full mx-auto overflow-hidden">
+            {{- if .ReadmeFileName -}}
+            <div class="px-4 py-2 bg-gray-50 dark:bg-gray-700 border-b border-gray-200 dark:border-gray-600 flex items-center gap-2">
+                {{ i "file-text" "w-4 h-4" "text-gray-600 dark:text-gray-400" }}
+                <span class="font-mono text-sm text-gray-800 dark:text-gray-200">{{ .ReadmeFileName }}</span>
+            </div>
+            {{- end -}}
+            <section
+                class="p-6 overflow-auto {{ if not .Raw }}
+                    prose dark:prose-invert dark:[&_pre]:bg-gray-900
+                    dark:[&_code]:text-gray-300 dark:[&_pre_code]:bg-gray-900
+                    dark:[&_pre]:border dark:[&_pre]:border-gray-700
+                {{ end }}"
+            >
+                <article class="{{ if .Raw }}whitespace-pre{{ end }}">{{- if .Raw -}}<pre class="dark:bg-gray-800 dark:text-white overflow-x-auto">
+                            {{- .Readme -}}
+                        </pre>
+                    {{- else -}}
+                        {{ .HTMLReadme }}
+                    {{- end -}}</article>
+            </section>
+        </div>
+    {{- end -}}
+{{ end }}
-- 
2.43.0