add llms.txt

Author: igorzubarev

config-geekdoc.toml

@@ -32,9 +32,9 @@ pluralizeListTitles = false
         style               = "github"
 
 [outputs]
-    home                    = [ "HTML", "SITEMAP"]
-    section                 = [ "HTML" ]
-    page                    = [ "HTML" ]
+    home                    = [ "HTML", "SITEMAP", "Markdown"]
+    section                 = [ "HTML", "Markdown" ]
+    page                    = [ "HTML", "Markdown" ]
 
 [outputFormats.SITEMAP]
     MediaType               = "application/xml"
@@ -77,6 +77,9 @@ pluralizeListTitles = false
                                 "merger_cloud", "signature_cloud",
                                 "comparison_cloud"
                             ]
+							
+	llmsTXT = true							
+	
 [Params.Sitemap]
 	changeFreq              = "weekly"
 	priority                = 0.5

themes/hugo-geekdoc/assets/llms.go.txt

@@ -0,0 +1,57 @@
+{{ with .Site.Title -}}
+    # {{ . }}
+{{- end }}
+
+{{ with .Site.Params.Description -}}
+> {{ . }}
+{{- end }}
+{{ range (where (sort ((.Site.GetPage "/").Pages) "Weight" "asc" "Date" "desc" "Lastmod" "desc") "Params.sitemap_exclude" "ne" true) -}}
+    {{- $link := .Permalink -}}
+    {{- with .OutputFormats.Get "markdown" -}}
+        {{- $link = .Permalink -}}
+    {{- end -}}
+    {{ printf "\n- [%s](%s): %s" .Title $link .Description }}
+{{- end -}}
+
+{{/* Sections */}}
+{{- range (where (sort ((.Site.GetPage "/").Sections) "Weight" "asc" "Date" "desc" "Lastmod" "desc") "Params.sitemap_exclude" "ne" true) -}}
+{{ with .Title -}}
+    ## {{ . }}
+{{- end }}
+
+{{ with .Description -}}
+    > {{ . }}
+{{- end }}
+
+{{ range (where (sort .Pages "Weight" "asc" "Date" "desc" "Lastmod" "desc") "Params.sitemap_exclude" "ne" true) -}}
+    {{- $link := .Permalink -}}
+    {{- with .OutputFormats.Get "markdown" -}}
+        {{- $link = .Permalink -}}
+    {{- end -}}
+    {{ if .Title -}}
+        - [{{ .Title }}]({{ $link }}){{ with .Description }}: {{ . }}{{ end }}
+    {{- end }}
+{{ end -}}
+
+{{/* Sub-Sections */}}
+{{ range (where (sort .Sections "Weight" "asc" "Date" "desc" "Lastmod" "desc") "Params.sitemap_exclude" "ne" true) -}}
+{{ with .Title -}}
+    ### {{ . }}
+{{- end }}
+
+{{ with .Description -}}
+    > {{ . }}
+{{- end }}
+
+{{ range (where (sort .Pages "Weight" "asc" "Date" "desc" "Lastmod" "desc") "Params.sitemap_exclude" "ne" true) -}}
+    {{- $link := .Permalink -}}
+    {{- with .OutputFormats.Get "markdown" -}}
+        {{- $link = .Permalink -}}
+    {{- end -}}
+    {{ if .Title -}}
+        - [{{ .Title }}]({{ $link }}){{ with .Description }}: {{ . }}{{ end }}
+    {{- end }}
+{{ end }}
+{{ end -}}
+
+{{ end -}}

themes/hugo-geekdoc/layouts/_default/section.markdown.md

@@ -0,0 +1,2 @@
+{{ .RawContent }} {{ range .Pages }}
+	{{ partial "docs-container.md" . }} {{ end }}

themes/hugo-geekdoc/layouts/_default/single.markdown.md

@@ -0,0 +1,4 @@
+---
+title: "{{ .Title }}"
+---
+{{ .RawContent }}

themes/hugo-geekdoc/layouts/home.markdown.md

@@ -0,0 +1,4 @@
+---
+title: "{{ .Title }}"
+---
+{{ .RawContent }}

themes/hugo-geekdoc/layouts/partials/docs-container.md

@@ -0,0 +1,32 @@
+{{- $link := .Permalink -}}
+{{- with .OutputFormats.Get "markdown" -}}
+  {{- $link = .Permalink -}}
+{{- end }}
+{{ with .Site.GetPage .RelPermalink }} 
+    {{- if .Params.index_title }}
+##### [{{ .Params.index_title }}]({{ $link }}) 
+    {{- else if .Params.breadcrumb }}
+##### [{{ .Params.breadcrumb }}]({{ $link }}) 
+    {{- else }}
+##### [{{ .LinkTitle }}]({{ $link }}) 
+    {{- end }} 
+    {{ if .Params.last_updated }}
+* **Last updated:** {{ .Params.last_updated }} 
+    {{- end -}} 
+    {{ if .Params.categories }}
+* **Categories:** 
+        {{- range .Params.categories }}
+    * {{ . }} 
+        {{- end -}} 
+    {{- end -}} 
+    {{ if .Params.tags }}
+* **Tags:** 
+        {{- range .Params.tags }} 
+    * {{ . }} 
+        {{- end -}} 
+    {{- end -}} 
+    {{ if .Params.brief }}
+
+{{ .Params.brief }} 
+    {{- end }} 
+{{- end }}

themes/hugo-geekdoc/layouts/robots.txt

@@ -2,3 +2,9 @@ User-agent: *
 Disallow: /tags/*
 
 Sitemap: {{ "sitemap.xml" | absURL }}
+{{/* LLMS */}}
+{{- $llmsGoTXT := resources.Get "llms.go.txt" -}}
+{{- if and $llmsGoTXT .Site.Params.llmsTXT -}}
+  {{- $llmsTXT := $llmsGoTXT | resources.ExecuteAsTemplate "llms.txt" . -}}
+  llms-txt: {{ $llmsTXT.Permalink }}
+{{- end -}}