moesif-jekyll-llmstxt 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 195e26776c1399f02b430033aa40add9703f3195b1d2d593924f9903a13f7196
+  data.tar.gz: e381646c0e45a46fc00dc7656e227b84a5b858257c4c0902bfee35ab57db9c5d
+SHA512:
+  metadata.gz: 7ce050aa46f2aa23959f28203b24f3b88e567bcf5255904b5cec45ce19c4400fc8ccba03657f4ffe36a8baa17fc5a5e5daee23766001ac9522ebfdfc376ba218
+  data.tar.gz: 368b0570548b52d7288e5f273a116585b204c07b58cebd798367cd9495f3bc5b5fe6c58ea80eb2fb9bf67f91577424f16f8f42ba5b8d6d1d3dc3600d996ecd7a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kyle Gao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# jekyll-llmstxt
+
+This is a Jekyll plugin that makes your site more LLM-friendly according to the
+spec from [llmstxt.org](https://llmstxt.org). It generates a `/llms.txt` file
+that contains basic information about your site and links to all posts in thei
+raw markdown format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-llmstxt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-llmstxt

data/lib/jekyll-llmstxt/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Llmstxt
+    VERSION = "0.1.2"
+  end
+end

data/lib/jekyll-llmstxt.rb

@@ -0,0 +1,60 @@
+require 'jekyll'
+
+module Jekyll
+  class LLMSGenerator < Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      # Create llms.txt file at site root
+      site.pages << Jekyll::PageWithoutAFile.new(site, site.source, "", "llms.txt").tap do |file|
+        file.content = site.config["title"] ? "# #{site.config["title"]}\n\n" : ""
+        file.content += site.config["description"] ? "#{site.config["description"]}\n\n" : ""
+
+        site.collections.each do |collection_name, collection|
+            # Check if the collection has any documents
+            unless collection.docs.empty?
+
+              title_cased_name = collection_name.split.map(&:capitalize).join(' ')
+              file.content += "## #{title_cased_name}:\n\n"
+
+              collection.docs.each do |post|
+                post_url = site.baseurl ? File.join(site.baseurl, post.url) : post.url
+                file.content += "- [#{post.data["title"]}](#{post_url}index.md)\n"
+              end
+              file.content += "\n\n"
+            end
+        end
+
+        file.data["layout"] = nil
+      end
+
+    end
+  end
+
+  class MarkdownPage < Page
+    def initialize(site, base, dir, name, content)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = name
+
+      self.process(name)
+      self.content = content
+      self.data = {
+        "layout" => nil, # Set layout if needed, or leave nil
+        "title" => "Generated Markdown File",
+      }
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  site.collections.each do |collection_name, collection|
+    collection.docs.each do |post|
+      target_dir = File.join(site.dest, post.url)
+      target_path = File.join(target_dir, "index.md")
+      FileUtils.cp(post.path, target_path)
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: moesif-jekyll-llmstxt
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Derric Gilling
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- derric@moesif.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-llmstxt.rb
+- lib/jekyll-llmstxt/version.rb
+homepage: https://github.com/Moesif/jekyll-llmstxt
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Generate llms.txt for Jekyll site
+test_files: []