add llms.txt

Author: tony-xlh

_plugins/raw_content.rb

@@ -0,0 +1,48 @@
+# _plugins/raw_content.rb
+module Jekyll
+  class RawContentForCollections < Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      site.collections.each do |label, collection|
+        
+        collection.docs.each do |doc|
+          add_raw_content_to_document(site, doc)
+        end
+      end
+      
+      site.pages.each do |page|
+        add_raw_content_to_document(site, page)
+      end
+      
+    end
+
+    private
+
+    def add_raw_content_to_document(site, document)
+      if document.respond_to?(:relative_path) && document.relative_path
+        source_path = File.join(site.source, document.relative_path)
+      elsif document.respond_to?(:path) && document.path
+        source_path = document.path
+      else
+        return
+      end
+      
+      if File.exist?(source_path)
+        raw_file_content = File.read(source_path, encoding: 'UTF-8')
+        content_without_front_matter = remove_front_matter(raw_file_content)
+        document.data['raw_content'] = content_without_front_matter
+      end
+    end
+
+    def remove_front_matter(content)
+      if content =~ /\A---\s*\n.*?\n---\s*\n+/m
+        result = content.sub(/\A---\s*\n.*?\n---\s*\n+/m, '')
+        return result
+      else
+        return content
+      end
+    end
+  end
+end

articles.json

@@ -0,0 +1,16 @@
+---
+layout: null
+sitemap: false
+---
+{
+  "articles": [
+    {% for article in site.pages %}
+    {
+      "title": {{ article.title | jsonify }},
+      "url": "https://www.dynamsoft.com{{ article.url | relative_url }}",
+      "content": {{ article.raw_content | jsonify }},
+      "breadcrumb": {{ article.breadcrumbText | default: article.title | jsonify }}
+    }{% unless forloop.last %},{% endunless %}
+    {% endfor %}
+  ]
+}

llms-full.txt

@@ -0,0 +1,17 @@
+---
+layout: null
+sitemap: false
+---
+{% for article in site.pages %}{% if article.title %}<page>
+---
+title: {{article.title}}
+description: {{article.description}}
+source_url:
+  html: https://www.dynamsoft.com{{ article.url | relative_url }}
+  md: {{ site.repositoryUrl }}/{{article.path}}
+---
+{{ article.raw_content }}
+</page>{% endif %}
+
+{% endfor %}
+

llms.txt

@@ -0,0 +1,15 @@
+---
+layout: null
+sitemap: false
+---
+
+# Dynamsoft Document Viewer Docs
+
+## Docs
+
+{% for article in site.pages %}{% if article.title %}- [{{article.title}}](https://www.dynamsoft.com{{ article.url | relative_url }}): {{ article.description }}{% endif %}
+{% endfor %}
+
+## Samples
+
+- [Samples](https://github.com/Dynamsoft/document-viewer-samples/): Samples of Dynamsoft Document Viewer