jekyll-llms 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23293734537766446bec10323faae85e54243da602e80bca5d8675feffff8abd
-  data.tar.gz: 33b4069fbc9e69e04305f33f487788d67e279a2f60842d789400d7f43de87c20
+  metadata.gz: 48ccdbd84d3c01d8fc4efa05141ab0501416004faf3185fd0e613488ef98accb
+  data.tar.gz: 7d116b7037ffd8a96cc7b05ce5f3b2990b772a183e1c4d795f5f6c91b9c5d814
 SHA512:
-  metadata.gz: a0e1ad5425441b17e99e316762b097c2f00f8b259cf4b9742ce9440d3712d740b51a160d95317459b94677dcd4fc3a1262e3e5642dba949394216c1af3a1101c
-  data.tar.gz: fac4f5e71fce6d09cfc476ac61fe236cfb00fa181d90be85eaa2cf0f17fbf0d62c9804ef11abfc36ae0618acc0b559ac7cc7b13331ed050a87b86b7d3e9ec758
+  metadata.gz: fc07ec9876c91ba823fd05334393c7f713a58460b9e5d6bffe605b6dbc67fc76c5f8c0e25dff4e4485970ea30148d3fb6f3ba218632ec98d90d1a320e6b4f2cd
+  data.tar.gz: fa433ac872fdf80b6f87152209fe06ce7202b2dfadfc8540028bc5f2892c7ca38245a1dee3d4e024124fc4ca5097f75b6ff93314a7b8aab8fe081060178862ac

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.2.0
+
+### Fixed
+
+- Ensure that one invalid markdown file will not block publishing of all markdown files.
+
+## 0.1.1
+
+### Changed
+
+- Exclude `/README.md` and `/CHANGELOG.md` by default. Set `llms.exclude` to replace this list.
+
+### Fixed
+
+- Copy Markdown sidecars only based off already existing  Markdown files
+- Keep HTML-source entries linked to their original URLs in `llms.txt` and skip Markdown alternate links for them.
+
+## 0.1.0 - 2026-05-03
+
+### Added
+
+- Generate `llms.txt` for included pages, posts, and output collections.
+- Generate Markdown source sidecars for included entries.
+- Add HTML alternate links pointing to generated Markdown sidecars.

data/README.md

@@ -24,10 +24,10 @@ plugins:
 ## Output
 
 - `/llms.txt`: Markdown index of included entries.
-- `*.md`: source-body sidecars for included entries.
+- `*.md`: source-body sidecars for included Markdown-source entries.
 - HTML `<link rel="alternate" type="text/markdown" href="...">` tags pointing to sidecars.
 
-Sidecars are source bodies, not HTML-to-Markdown conversions. Front matter is removed. Liquid is rendered unless `render_with_liquid: false` is set.
+Sidecars are source bodies, not HTML-to-Markdown conversions. Front matter is removed. Liquid is rendered unless `render_with_liquid: false` is set. HTML-source entries stay linked by their original URLs.
 
 ## Configuration
 
@@ -39,14 +39,16 @@ llms:
     - pages
     - posts
   exclude:
+    - /README.md
+    - /CHANGELOG.md
     - /404.html
     - /assets/**
 ```
 
-- `markdown`: generate sidecars, link `llms.txt` to sidecars, and add HTML alternate links. Default: `true`.
+- `markdown`: generate sidecars for Markdown sources, link `llms.txt` to those sidecars, and add HTML alternate links. Default: `true`.
 - `llms_txt`: generate `/llms.txt`. Default: `true`.
 - `include`: `pages`, `posts`, and output collection names. Default: `[pages, posts]`.
-- `exclude`: URL, Markdown path, or source path globs. Default: `[]`.
+- `exclude`: URL, Markdown path, or source path globs. Default: `[/README.md, /CHANGELOG.md]`.
 
 Per-entry opt-out:
 

data/lib/jekyll/llms/config.rb

@@ -7,7 +7,7 @@ module Jekyll
         "markdown" => true,
         "llms_txt" => true,
         "include" => %w[pages posts],
-        "exclude" => [],
+        "exclude" => ["/README.md", "/CHANGELOG.md"],
       }.freeze
 
       def self.from_site(site)

data/lib/jekyll/llms/entry.rb

@@ -6,6 +6,7 @@ module Jekyll
       attr_reader :item, :section, :url
 
       def initialize(site:, item:, section:)
+        @site = site
         @item = item
         @section = section
         @url = Url.new(site: site, item: item)
@@ -19,6 +20,10 @@ module Jekyll
         item.data.fetch("llms", true)
       end
 
+      def markdown_source?
+        markdown_extensions.include?(File.extname(item.relative_path).delete_prefix("."))
+      end
+
       def excluded_by?(patterns)
         patterns.any? do |pattern|
           url.matches?(pattern)
@@ -34,6 +39,12 @@ module Jekyll
 
       private
 
+      attr_reader :site
+
+      def markdown_extensions
+        site.config.fetch("markdown_ext", Configuration::DEFAULTS.fetch("markdown_ext")).split(",")
+      end
+
       def fallback_title
         if item.respond_to?(:basename_without_ext)
           item.basename_without_ext

data/lib/jekyll/llms/index.rb

@@ -3,10 +3,10 @@
 module Jekyll
   module Llms
     class Index
-      def initialize(site:, entries:, markdown:)
+      def initialize(site:, entries:, url_for:)
         @site = site
         @entries = entries
-        @markdown = markdown
+        @url_for = url_for
       end
 
       def content
@@ -25,7 +25,7 @@ module Jekyll
 
       private
 
-      attr_reader :site, :entries, :markdown
+      attr_reader :site, :entries, :url_for
 
       def title
         site.config.fetch("title", "Jekyll Site")
@@ -36,7 +36,7 @@ module Jekyll
       end
 
       def entry_line(entry)
-        line = "- [#{entry.title}](#{entry.url.absolute(markdown: markdown)})"
+        line = "- [#{entry.title}](#{url_for.call(entry)})"
         entry.description.empty? ? line : "#{line}: #{entry.description}"
       end
 

data/lib/jekyll/llms/site_writer.rb

@@ -11,29 +11,49 @@ module Jekyll
       end
 
       def write
-        write_index if config.llms_txt?
-        if config.markdown?
-          write_markdown
-          write_html_links
-        end
+        markdown_entries = config.markdown? ? write_markdown : []
+
+        write_index(markdown_entries) if config.llms_txt?
+        write_html_links(markdown_entries)
       end
 
       private
 
       attr_reader :site, :config, :entries, :files
 
-      def write_index
-        files.write("llms.txt", Index.new(site: site, entries: entries, markdown: config.markdown?).content)
+      def write_index(markdown_entries)
+        files.write("llms.txt", Index.new(site: site, entries: entries, url_for: index_url(markdown_entries)).content)
+      end
+
+      def index_url(markdown_entries)
+        lambda do |entry|
+          entry.url.absolute(markdown: markdown_entries.include?(entry))
+        end
       end
 
       def write_markdown
-        entries.each do |entry|
-          files.write(entry.url.markdown_path, MarkdownSource.new(site: site, item: entry.item).content)
+        markdown_entries.filter_map do |entry|
+          content = markdown_content(entry)
+          next unless content
+
+          files.write(entry.url.markdown_path, content)
+          entry
         end
       end
 
-      def write_html_links
-        HtmlLinker.new(site: site, entries: entries).write
+      def markdown_content(entry)
+        MarkdownSource.new(site: site, item: entry.item).content
+      rescue Liquid::Error, SystemCallError => error
+        Jekyll.logger.warn("LLMs:", "Skipping markdown sidecar for #{entry.item.relative_path}: #{error}")
+        nil
+      end
+
+      def write_html_links(markdown_entries)
+        HtmlLinker.new(site: site, entries: markdown_entries).write
+      end
+
+      def markdown_entries
+        entries.select(&:markdown_source?)
       end
     end
   end

data/lib/jekyll/llms/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Llms
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-llms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stanislav Katkov
@@ -106,6 +106,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/jekyll-llms.rb