Add template and workflow for llms.txt file

Author: vladimir-litvinchik

.github/workflows/build-and-deploy.yml

@@ -201,6 +201,10 @@ jobs:
         if: ${{ !inputs.all_products }}
         run: rm -f ./public/index.json
 
+      - name: Remove llms.txt (incomplete on partial builds)
+        if: ${{ !inputs.all_products }}
+        run: rm -f ./public/llms.txt
+
       - name: Deploy artifacts
         uses: burnett01/rsync-deployments@7.0.1
         with:

.github/workflows/publish-llms-txt.yml

@@ -0,0 +1,104 @@
+# Build llms.txt from all product documentation repositories
+name: publish-llms-txt
+
+# This workflow can be triggered independently
+on: workflow_dispatch
+
+jobs:
+
+  build:
+    runs-on: self-hosted
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Hugo
+        run: |
+          curl -LO https://github.com/gohugoio/hugo/releases/download/v0.101.0/hugo_extended_0.101.0_Linux-64bit.deb
+          sudo dpkg -i hugo_extended_0.101.0_Linux-64bit.deb
+
+      - name: Download documentation repositories
+        run: |
+          # Each entry is "product_key:ProductName"
+          # Repo URL pattern: https://github.com/groupdocs-{key}/GroupDocs.{Name}-Docs
+          PRODUCTS="
+            annotation:Annotation
+            assembly:Assembly
+            classification:Classification
+            comparison:Comparison
+            conversion:Conversion
+            editor:Editor
+            markdown:Markdown
+            merger:Merger
+            metadata:Metadata
+            parser:Parser
+            redaction:Redaction
+            search:Search
+            signature:Signature
+            total:Total
+            viewer:Viewer
+            watermark:Watermark
+          "
+
+          for entry in $PRODUCTS; do
+            product="${entry%%:*}"
+            product_name="${entry##*:}"
+            repo_url="https://github.com/groupdocs-${product}/GroupDocs.${product_name}-Docs.git"
+
+            echo "::group::Downloading ${product} documentation"
+            echo "Repository: groupdocs-${product}/GroupDocs.${product_name}-Docs"
+
+            git clone --depth 1 "${repo_url}" "temp-${product}" 2>&1 || {
+              echo "::warning::Failed to clone GroupDocs.${product_name}-Docs"
+              echo "::endgroup::"
+              continue
+            }
+
+            # Create content directory for this product
+            mkdir -p "content/${product}"
+
+            # Copy product family index page
+            if [ -f "temp-${product}/_index.md" ]; then
+              cp "temp-${product}/_index.md" "content/${product}/"
+              echo "Copied _index.md"
+            fi
+
+            # Copy platform-specific documentation folders
+            for platform in net java nodejs-java python-net; do
+              if [ -d "temp-${product}/${platform}" ]; then
+                cp -r "temp-${product}/${platform}" "content/${product}/"
+                echo "Copied ${platform}/ folder"
+              fi
+            done
+
+            # Cleanup cloned repo
+            rm -rf "temp-${product}"
+            echo "::endgroup::"
+          done
+
+          echo ""
+          echo "=== Content structure ==="
+          ls -la content/
+
+      - name: Build site
+        run: |
+          hugo
+
+      - name: Verify llms.txt
+        run: |
+          if [ ! -f "./public/llms.txt" ]; then
+            echo "::error::llms.txt was not generated"
+            exit 1
+          fi
+          echo "llms.txt size: $(wc -c < ./public/llms.txt) bytes"
+          echo "--- llms.txt content ---"
+          cat ./public/llms.txt
+
+      - name: Deploy llms.txt
+        uses: nogsantos/scp-deploy@master
+        with:
+          src: ./public/llms.txt
+          host: ${{ secrets.DOCS_SSH_HOST }}
+          remote: ${{ secrets.DOCS_SSH_DIR }}
+          user: ${{ secrets.DOCS_SSH_USER }}
+          key: ${{ secrets.DOCS_SSH_KEY }}

.gitignore

@@ -35,3 +35,4 @@ content/signature/
 content/total/
 content/viewer/
 content/watermark/
+.claude/settings.local.json

config.toml

@@ -32,7 +32,7 @@ pluralizeListTitles = false
         style               = "github"
 
 [outputs]
-    home                    = [ "HTML", "SITEMAP", "JSON", "MD"]
+    home                    = [ "HTML", "SITEMAP", "JSON", "MD", "LLMSTXT"]
     section                 = [ "HTML", "MD" ]
     page                    = [ "HTML", "MD" ]
 
@@ -47,6 +47,12 @@ pluralizeListTitles = false
 [mediaTypes."text/markdown"]
     suffixes                = ["md"]
 
+[outputFormats.LLMSTXT]
+    mediaType               = "text/plain"
+    baseName                = "llms"
+    isPlainText             = true
+    notAlternative          = true
+
 [outputFormats.MD]
     mediaType               = "text/markdown"
     isPlainText             = true

layouts/index.llmstxt

@@ -0,0 +1,30 @@
+{{- /* llms.txt output template for the home page */ -}}
+# {{ .Site.Title }}
+
+> {{ .Site.Params.description | default .Description }}
+
+GroupDocs provides on-premise document processing SDKs for .NET, Java, Python, and Node.js. This documentation site covers all product families and platforms.
+
+## Product Families
+
+{{ range .Site.Sections -}}
+{{ $product := .File.ContentBaseName -}}
+{{ $title := .Title -}}
+- [{{ $title }}]({{ .Permalink }}) {{ with .Description }}— {{ . }}{{ end }}
+{{ range .Sections -}}
+  - [{{ $title }} for {{ .Title }}]({{ .Permalink }}) ([full content]({{ strings.TrimRight "/" .Permalink }}.md))
+{{ end -}}
+{{ end }}
+## Developer Resources
+
+- [API Reference](https://reference.groupdocs.com/)
+- [Code Samples](https://groupdocs.github.io/)
+- [Free Support Forum](https://forum.groupdocs.com/)
+- [Paid Support Helpdesk](https://helpdesk.groupdocs.com/)
+- [Free Consulting](https://forum.groupdocs.com/c/free-consulting/37)
+- [Online Apps & Demos](https://products.groupdocs.app/)
+
+## Optional
+
+- All documentation pages are available in Markdown format at `{page-path}.md` (e.g. `/viewer/net/` → `/viewer/net.md`).
+- The [product sitemap]({{ "product-sitemap.xml" | absURL }}) lists all available pages.