RubyGems - jekyll-llms-generator - Versions diffs - 0.1.0 - Mend

jekyll-llms-generator 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +15 -0
data/LICENSE.txt +21 -0
data/README.md +117 -0
data/lib/jekyll/llms_txt_generator.rb +219 -0
data/lib/jekyll-llms-generator/version.rb +5 -0
data/lib/jekyll-llms-generator.rb +4 -0
metadata +71 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ded1a72f3e590ee00a81fa796362243e35b58e419f158f851a7ca4db19905ce8
+  data.tar.gz: 89c1b7b0b246359871a47b872c92e198f85bd8d61d6bf9f72ca8e9c49ce2dca9
+SHA512:
+  metadata.gz: d1238923ed9780e6a0314b9b2a03407b40036948f1ee241147e4820036d2db3c5167972d970f468803853eca4613ee2881e4d3471df8ccf4222889563d026f96
+  data.tar.gz: 284fd114b4d63d660c3619ecbb1352057035b8ef9ed1ed6708eb1bdbeef78932849f9a111ef96acebfbb2fc120a79d87e990d671f9c0a6a4076707eb40869495

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+## [0.1.0] - 2025-07-08
+### Added
+- Initial release
+- `Jekyll::Generator` that builds `/llms.txt` automatically on each build
+- Support for posts, named collections, and explicit page URLs per section
+- Per-document opt-out via `llms_txt: false` frontmatter
+- Optional `/llms-full.txt` with stripped-HTML content (config: `full: true`)
+- Optional `<link rel="ai" href="/llms.txt">` injection into HTML `<head>`
+- Limit control per section (`limit:`)
+- Geocoding-style configuration with `title`, `tagline`, `intro`, and `sections`

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2025 Jason Chance
+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 ADDED Viewed

@@ -0,0 +1,117 @@
+# jekyll-llms-generator
+A Jekyll generator plugin that automatically builds an `/llms.txt` file every time your site builds — keeping AI language models up to date with your latest content.
+[![Gem Version](https://badge.fury.io/rb/jekyll-llms-generator.svg)](https://badge.fury.io/rb/jekyll-llms-generator)
+## What is llms.txt?
+[llms.txt](https://llmstxt.org/) is an emerging convention that lets website owners expose a structured plain-text summary of their site's content for AI models and LLM crawlers. It's like `robots.txt`, but instead of telling crawlers what to ignore it tells them what matters and where to find it.
+## Installation
+Add to your site's `Gemfile`:
+```ruby
+gem "jekyll-llms-generator", "~> 0.1"
+```
+Add to your `_config.yml` plugins list:
+```yaml
+plugins:
+  - jekyll-llms-generator
+```
+Then run `bundle install`.
+## Configuration
+All configuration lives under the `llms_txt:` key in `_config.yml`.
+```yaml
+llms_txt:
+  title: "Jason Chance"
+  tagline: "Downtown revitalization, local government technology, and public finance."
+  intro: |
+    Jason Chance is a DDA director and web developer writing about public finance,
+    local government technology, and downtown revitalization.
+  link_tag: true       # inject <link rel="ai" href="/llms.txt"> into every HTML page (default: true)
+  full: false          # also generate /llms-full.txt with full stripped-HTML content (default: false)
+  sections:
+    - title: "Blog Posts"
+      collection: posts
+      limit: 20          # optional: cap number of items
+    - title: "Projects"
+      collection: projects
+    - title: "Pages"
+      pages:
+        - /about/
+        - /contact/
+```
+### Options
+| Key | Default | Description |
+|-----|---------|-------------|
+| `title` | site `title` | H1 heading at the top of `llms.txt` |
+| `tagline` | site `description` | Blockquote line below the title |
+| `intro` | _(none)_ | Optional paragraph after the tagline |
+| `link_tag` | `true` | Inject `<link rel="ai" href="/llms.txt">` into HTML head |
+| `full` | `false` | Also generate `/llms-full.txt` with full content |
+| `sections` | `[]` | Array of section definitions (see below) |
+### Section options
+Each section must have a `title`. Specify one or both of `collection` and `pages`.
+| Key | Description |
+|-----|-------------|
+| `collection` | Jekyll collection name (`posts`, `projects`, etc.) |
+| `limit` | Max number of items from this collection |
+| `pages` | Array of page URLs to include |
+### Opt-out per document
+Add `llms_txt: false` to any post or collection document's frontmatter to exclude it:
+```yaml
+---
+title: "Internal Draft"
+llms_txt: false
+---
+```
+### Description used in llms.txt
+The plugin looks for a description in this order:
+1. `description:` frontmatter
+2. `tagline:` frontmatter
+3. Automatically generated excerpt (first paragraph)
+## Output
+**`/llms.txt`** — compact reference with title, tagline, intro, and a bulleted list of links per section.
+**`/llms-full.txt`** — same structure but each item also includes the full plain-text content of the document (when `full: true`).
+## Discovery
+AI crawlers discover `llms.txt` by checking `<your-site>/llms.txt` directly, the same way they check `robots.txt` or `sitemap.xml`. The optional `<link rel="ai">` injection in the `<head>` of every page provides an additional signal.
+You can also submit your site to the [llmstxt.org directory](https://directory.llmstxt.cloud/) for broader discovery.
+## Compatibility
+- Jekyll 3.7 – 4.x
+- Ruby 2.7+
+- Works with GitHub Pages via the `remote_theme` workflow (plugin must be listed in `plugins:`)
+## Contributing
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+## License
+[MIT](LICENSE.txt) © Jason Chance

data/lib/jekyll/llms_txt_generator.rb ADDED Viewed

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+require "jekyll"
+module Jekyll
+  class LlmsTxtGenerator < Generator
+    safe true
+    priority :low
+    def generate(site)
+      @site = site
+      @config = site.config["llms_txt"] || {}
+      return unless @config["enabled"] != false
+      # Store content on site object so the post_write hook can access it
+      site.data["__llms_txt_content"] = build_llms_txt
+      if @config["full"]
+        site.data["__llms_full_txt_content"] = build_llms_full_txt
+      end
+      inject_link_tag(site) if @config["link_tag"] != false
+    end
+    private
+    def site_base_url
+      url = @site.config["url"].to_s.chomp("/")
+      baseurl = @site.config["baseurl"].to_s.chomp("/")
+      "#{url}#{baseurl}"
+    end
+    def build_llms_txt
+      lines = []
+      title = @config["title"] || @site.config["title"] || "Site"
+      lines << "# #{title}"
+      tagline = @config["tagline"] || @site.config["description"]
+      lines << "\n> #{tagline}" if tagline && !tagline.empty?
+      intro = @config["intro"]
+      if intro && !intro.empty?
+        lines << ""
+        lines << intro.strip
+      end
+      sections = @config["sections"] || []
+      sections.each do |section|
+        items = collect_section_items(section)
+        next if items.empty?
+        lines << ""
+        lines << "## #{section["title"]}"
+        items.each do |item|
+          lines << format_item(item)
+        end
+      end
+      lines.join("\n") + "\n"
+    end
+    def build_llms_full_txt
+      lines = []
+      title = @config["title"] || @site.config["title"] || "Site"
+      lines << "# #{title}"
+      tagline = @config["tagline"] || @site.config["description"]
+      lines << "\n> #{tagline}" if tagline && !tagline.empty?
+      intro = @config["intro"]
+      if intro && !intro.empty?
+        lines << ""
+        lines << intro.strip
+      end
+      sections = @config["sections"] || []
+      sections.each do |section|
+        items = collect_section_items(section)
+        next if items.empty?
+        lines << ""
+        lines << "## #{section["title"]}"
+        items.each do |item|
+          lines << format_item_full(item)
+        end
+      end
+      lines.join("\n") + "\n"
+    end
+    def collect_section_items(section)
+      items = []
+      if section["collection"]
+        items += items_from_collection(section["collection"], section["limit"])
+      end
+      if section["pages"]
+        items += items_from_pages(section["pages"])
+      end
+      items
+    end
+    def items_from_collection(collection_name, limit = nil)
+      docs = if collection_name == "posts"
+               @site.posts.docs
+             elsif @site.collections[collection_name]
+               @site.collections[collection_name].docs
+             else
+               []
+             end
+      docs = docs.reject { |d| d.data["llms_txt"] == false }
+      docs = docs.sort_by { |d| d.data["date"] || Time.now }.reverse
+      docs = docs.first(limit) if limit
+      docs.map { |d| doc_to_item(d) }
+    end
+    def items_from_pages(page_urls)
+      page_urls.filter_map do |url|
+        page = @site.pages.find { |p| p.url == url || p.url == "#{url}index.html" }
+        next if page.nil?
+        next if page.data["llms_txt"] == false
+        {
+          title: page.data["title"] || page.url,
+          url: "#{site_base_url}#{page.url}",
+          description: page.data["description"] || page.data["excerpt"],
+          content: page.content
+        }
+      end
+    end
+    def doc_to_item(doc)
+      description = doc.data["description"] ||
+                    doc.data["tagline"] ||
+                    (doc.data["excerpt"]&.output ? strip_html(doc.data["excerpt"].output) : nil) ||
+                    (doc.excerpt ? strip_html(doc.excerpt.output) : nil)
+      {
+        title: doc.data["title"],
+        url: "#{site_base_url}#{doc.url}",
+        description: description&.strip&.gsub(/\s+/, " ")&.slice(0, 200),
+        content: doc.content
+      }
+    end
+    def format_item(item)
+      line = "- [#{item[:title]}](#{item[:url]})"
+      desc = item[:description]
+      line += ": #{desc}" if desc && !desc.empty?
+      line
+    end
+    def format_item_full(item)
+      lines = []
+      lines << "- [#{item[:title]}](#{item[:url]})"
+      if item[:content] && !item[:content].empty?
+        stripped = strip_html(item[:content]).strip.gsub(/\s+/, " ")
+        lines << "" << stripped << ""
+      end
+      lines.join("\n")
+    end
+    def strip_html(html)
+      return "" unless html
+      html.gsub(/<script[^>]*>.*?<\/script>/mi, "")
+          .gsub(/<style[^>]*>.*?<\/style>/mi, "")
+          .gsub(/<[^>]+>/, " ")
+          .gsub(/&nbsp;/, " ")
+          .gsub(/&amp;/, "&")
+          .gsub(/&lt;/, "<")
+          .gsub(/&gt;/, ">")
+          .gsub(/&quot;/, '"')
+          .gsub(/&#39;/, "'")
+          .gsub(/\s+/, " ")
+          .strip
+    end
+    def write_file(filename, content)
+      dest = @site.in_dest_dir(filename)
+      FileUtils.mkdir_p(File.dirname(dest))
+      File.write(dest, content)
+    end
+    def inject_link_tag(site)
+      llms_url = "#{site_base_url}/llms.txt"
+      site.pages.each do |page|
+        next unless page.output_ext == ".html"
+        page.content = page.content.to_s.sub(
+          %r{</head>}i,
+          %(<link rel="ai" href="#{llms_url}" />\n</head>)
+        )
+      end
+    end
+  end
+end
+Jekyll::Hooks.register :site, :post_write do |site|
+  content = site.data.delete("__llms_txt_content")
+  if content
+    dest = site.in_dest_dir("llms.txt")
+    FileUtils.mkdir_p(File.dirname(dest))
+    File.write(dest, content)
+  end
+  full_content = site.data.delete("__llms_full_txt_content")
+  if full_content
+    dest = site.in_dest_dir("llms-full.txt")
+    FileUtils.mkdir_p(File.dirname(dest))
+    File.write(dest, full_content)
+  end
+end

data/lib/jekyll-llms-generator/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module JekyllLlmsGenerator
+  VERSION = "0.1.0"
+end

data/lib/jekyll-llms-generator.rb ADDED Viewed

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require "jekyll-llms-generator/version"
+require "jekyll/llms_txt_generator"

metadata ADDED Viewed

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-llms-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Chance
+bindir: bin
+cert_chain: []
+date: 2026-08-21 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'
+description: jekyll-llms-generator is a Jekyll generator plugin that builds a standards-compliant
+  llms.txt file from your site's posts, collections, and pages so AI language models
+  can efficiently discover your content.
+email:
+- jason@jasonchance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/jekyll-llms-generator.rb
+- lib/jekyll-llms-generator/version.rb
+- lib/jekyll/llms_txt_generator.rb
+homepage: https://github.com/jchance/jekyll-llms-txt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jchance/jekyll-llms-txt
+  source_code_uri: https://github.com/jchance/jekyll-llms-txt
+  changelog_uri: https://github.com/jchance/jekyll-llms-txt/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Automatically generate an llms.txt file for your Jekyll site.
+test_files: []