Add llms.txt support

clevercloud-deploy-script.sh

@@ -2,4 +2,5 @@ wget https://github.com/gohugoio/hugo/releases/download/v$HUGO_VERSION/hugo_exte
 tar xvf hugo_extended_"$HUGO_VERSION"_Linux-64bit.tar.gz
 chmod +x ./hugo
 ./hugo mod get github.com/imfing/hextra@$HEXTRA_VERSION
-./hugo --gc --minify --destination public/developers
+./hugo --gc --minify --destination public/developers
+echo "AddType text/markdown;charset=UTF-8 .md" > public/.htaccess

content/guides/_index.md

@@ -10,6 +10,7 @@ aliases:
 - /doc/deploy/application/docker/tutorials
 type: "docs"
 comments: false
+llmsTxtOptional: true
 ---
 ## Frameworks
 

data/software_versions_shared_dedicated.yml

@@ -35,3 +35,5 @@ elasticsearch:
 redis:
   dedicated:
     - "v7.2.4"
+
+dev_message: "**Important**: Dev plans are free and **solely for testing purposes**. They don't provide the same guarantees or SLAs as dedicated plans."

hugo.yaml

@@ -17,9 +17,18 @@ module:
     max: "0.135.0"
 
 outputs:
-  home: [HTML]
-  page: [HTML]
-  section: [HTML, RSS]
+  home: [HTML, LLMS]
+  page: [HTML, Markdown]
+  section: [HTML, Markdown, RSS]
+
+outputFormats:
+  LLMS:
+    mediaType: "text/plain"
+    baseName: "llms"
+    isPlainText: true
+
+  Markdown:
+    baseName: index.html
 
 privacy:
   youtube:
@@ -37,6 +46,7 @@ languages:
     #title: "Documentation de Clever Cloud "
 
 params:
+  description: Clever Cloud is a Platform-as-a-Service (PaaS) cloud provider, an automated hosting platform for developers. Deploy your app easily and launch dependencies without having to worry about the infrastructure set up
   images:
   - /images/feature.png
   navbar:

layouts/_default/list.md

@@ -0,0 +1 @@
+{{ partial "markdown/include_entrypoint.md" .RawContent | htmlUnescape }}

layouts/_default/single.md

@@ -0,0 +1 @@
+{{ partial "markdown/include_entrypoint.md" .RawContent | htmlUnescape }}

layouts/hextra-home.llms.txt

@@ -0,0 +1,52 @@
+{{- if eq .Kind "home" -}}
+# {{ .Site.Title }}
+
+> {{ .Site.Params.description }}
+
+{{- $mainSections := where .Site.Sections "Type" "docs" -}}
+{{- $sortedSections := sort $mainSections "Title" }}
+{{- range $sortedSections }}
+{{- if and (not .Params.llmsTxtOptional) (gt (len .Pages) 0) }}
+{{- $allSections := slice . -}}
+{{- range .Sections -}}
+{{- if not .Params.llmsTxtOptional -}}
+{{- $allSections = $allSections | append . -}}
+{{- end -}}
+{{- end -}}
+{{- $sortedAllSections := sort $allSections "Title" -}}
+{{- range $sortedAllSections }}
+
+{{- if and (gt (len .Pages) 0) (not (strings.Contains .Title "Postmortem" )) }}
+
+## {{ .Title }}
+{{- $pages := sort .Pages "Title" "asc" }}
+{{- range $pages }}
+{{- if not (strings.Contains .RelPermalink "/api/v2") }}
+- [{{ .Title }}](https://www.clever-cloud.com{{ .RelPermalink }}index.html.md){{ with .Description }}: {{ . }}{{ end }}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+## Optional
+{{- range $mainSections }}
+{{- if .Params.llmsTxtOptional }}
+{{- $pages := sort .Pages "Title" "asc" }}
+{{- range $pages }}
+- [{{ .Title }}](https://www.clever-cloud.com{{ .RelPermalink }}index.html.md){{ with .Description }}: {{ . }}{{ end }}
+{{- end }}
+{{- end }}
+{{- range .Sections }}
+{{- if .Params.llmsTxtOptional }}
+{{- $pages := sort .Pages "Title" "asc" }}
+{{- range $pages }}
+- [{{ .Title }}]({{ .RelPermalink }}index.html.md){{ with .Description }}: {{ . }}{{ end }}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- end }}
+{{- else -}}
+{{- .RawContent | .Page.RenderString -}}
+{{- end -}}

layouts/partials/markdown/include_entrypoint.md

@@ -0,0 +1,5 @@
+{{- $content := . -}}
+{{- $content = partial "markdown/include_shortcode_content.md" $content -}}
+{{- $content = partial "markdown/include_runtimes_versions.md" $content -}}
+{{- $content = partial "markdown/include_software_versions_shared_dedicated.md" $content -}}
+{{ $content }}

layouts/partials/markdown/include_runtimes_versions.md

@@ -0,0 +1,32 @@
+{{- $content := . -}}
+{{- $runtimesPattern := "\\{\\{<\\s*runtimes_versions\\s+([^>]+)\\s*>\\}\\}" -}}
+
+{{- range $runtimeFound := findRE $runtimesPattern $content -}}
+    {{- $runtime := replaceRE $runtimesPattern "$1" $runtimeFound -}}
+    {{- $runtime = trim $runtime " " -}}
+    {{- $versions := index site.Data.runtime_versions $runtime -}}
+    {{- $output := "" -}}
+    {{- with $versions -}}
+        {{- if .default -}}
+            {{- $output = printf "%s### Default version\n" $output -}}
+            {{- range .default -}}
+                {{- $output = printf "%s- %s\n" $output . -}}
+            {{- end -}}
+        {{- end -}}
+
+        {{- if .accepted -}}
+            {{- $output = printf "%s\n### Accepted version(s)\n" $output -}}
+            {{- range .accepted -}}
+                {{- $output = printf "%s- %s\n" $output . -}}
+            {{- end -}}
+        {{- end -}}
+
+        {{- if .eol_source -}}
+            {{- $output = printf "%s\nCheck the [end-of-life (EOL)](%s) status of these versions." $output .eol_source -}}
+        {{- end -}}
+    {{- end -}}
+
+    {{- $content = replace $content $runtimeFound $output -}}
+{{- end -}}
+
+{{- return $content -}}

layouts/partials/markdown/include_shortcode_content.md

@@ -0,0 +1,13 @@
+{{- $content := . -}}
+{{- $patternSearch := "\\{\\{%\\s*content/([^%}]+)\\s*%\\}\\}" -}}
+{{- $patternClean := "\\{\\{%\\s*content/(.+?)\\s*%\\}\\}" -}}
+
+{{- range $shortcodeFound := findRE $patternSearch $content -}}
+    {{- $name := replaceRE $patternClean "$1" $shortcodeFound -}}
+    {{- $filepath := printf "layouts/shortcodes/content/%s.md" $name -}}
+    {{- with os.ReadFile $filepath -}}
+        {{- $content = replace $content $shortcodeFound . -}}
+    {{- end -}}
+{{- end -}}
+
+{{- return $content -}}

layouts/partials/markdown/include_software_versions_shared_dedicated.md

@@ -0,0 +1,23 @@
+{{- $content := . -}}
+{{- $versionsPattern := "\\{\\{<\\s*software_versions_shared_dedicated\\s+([^>]+)\\s*>\\}\\}" -}}
+
+{{- range $versionFound := findRE $versionsPattern $content -}}
+    {{- $dbname := replaceRE $versionsPattern "$1" $versionFound -}}
+    {{- $versions := index site.Data.software_versions_shared_dedicated $dbname -}}
+    {{- $output := "### Regular versions\n" -}}
+    {{- with $versions.dedicated -}}
+        {{- range . -}}
+            {{- $output = printf "%s- %s\n" $output . -}}
+        {{- end -}}
+    {{- end -}}
+    {{- if $versions.dev -}}
+        {{- $output = printf "%s\n### DEV plan\n" $output -}}
+        {{- range $versions.dev -}}
+            {{- $output = printf "%s- %s\n" $output . -}}
+        {{- end -}}
+        {{- $output = printf "%s\n%s" $output site.Data.software_versions_shared_dedicated.dev_message -}}
+    {{- end -}}
+    {{- $content = replace $content $versionFound $output -}}
+{{- end -}}
+
+{{- return $content -}}