RubyGems - jekyll-third-audience - Versions diffs - 0.1.0 - Mend

jekyll-third-audience 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 (9) hide show

checksums.yaml +7 -0
data/LICENSE.txt +21 -0
data/README.md +115 -0
data/lib/jekyll-third-audience/config.rb +22 -0
data/lib/jekyll-third-audience/generator.rb +76 -0
data/lib/jekyll-third-audience/meta_tag.rb +25 -0
data/lib/jekyll-third-audience/version.rb +5 -0
data/lib/jekyll-third-audience.rb +13 -0
metadata +111 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eab3d2ed521dc91879c340970539d128cf4cc4af571c690cc52d72786ed34d8b
+  data.tar.gz: e015c7017899c8b64935118fd05b1368ca57da324ab67e18c4881faf804bc13b
+SHA512:
+  metadata.gz: 8fddeea087660b6eab36c3f7e77db20f9f93949f70064bb7d4a9b3076ad6c387b92612932f1d7d0140239bfcce1edca9d78fc619e058d715545bef7811383bbe
+  data.tar.gz: 8dd29c297f61057d732e40d0649c3663e6a0c1b05a252b3f2c98dd92af78fdf21aaaf469317183b7c31f556e4a5a6df581b65891bc5683908cb6ac6bf80f550d

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2026 Drew Breunig
+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,115 @@
+# jekyll-third-audience
+A Jekyll plugin that generates clean Markdown copies of blog posts alongside their HTML output, making your content accessible to AI agents — the "third audience" of the web.
+In this case, "clean" means, "Removing includes and other things that match regex patterns you provide."
+Will this reduce AI traffic to your site? No, in fact it will likely increase it, as bots will have to read the HTML page to learn the Markdown version exists. But I like Markdown and I wish more sites provided Markdown versions, for human readers as well as robots.
+Inspired by [Dries Buytaert's article on the 'third audience'](https://dri.es/the-third-satisfying-audience-for-your-blog).
+## What it does
+1. **Generates `.md` files** — After Jekyll builds your site, the plugin writes a clean Markdown version of each post next to its HTML file. The Markdown version has structured front matter and the raw body content with no HTML, no includes, no Liquid tags.
+2. **Adds `<link>` tags** — The `{% third_audience_meta %}` Liquid tag outputs a `<link rel="alternate" type="text/markdown">` tag in your HTML `<head>`, telling AI agents where to find the Markdown version.
+## Installation
+Add to your `Gemfile`:
+```ruby
+gem "jekyll-third-audience"
+```
+Add to your `_config.yml`:
+```yaml
+plugins:
+  - jekyll-third-audience
+```
+Add to your `_includes/head.html` (or equivalent):
+```html
+{% third_audience_meta %}
+```
+Run `bundle install`.
+## Configuration
+Add a `third_audience` block to `_config.yml`. All settings are optional — these are the defaults:
+```yaml
+third_audience:
+  layouts:
+    - post
+  front_matter:
+    - title
+    - date
+    - author
+    - description
+    - tags
+    - url
+  strip_includes: []
+  replace_includes: []
+```
+### `layouts`
+Which layouts get `.md` versions and `<link>` tags. Default: `["post"]`.
+### `front_matter`
+Which fields to include in the Markdown file's YAML front matter. Default: `["title", "date", "author", "description", "tags", "url"]`.
+### `strip_includes`
+List of include filenames to remove entirely from the Markdown output:
+```yaml
+third_audience:
+  strip_includes:
+    - email_subscribe.html
+    - contact_form.html
+```
+This removes any `{% include email_subscribe.html %}` or `{% include contact_form.html %}` tags from the Markdown body.
+### `replace_includes`
+List of regex pattern/replacement rules for transforming includes:
+```yaml
+third_audience:
+  replace_includes:
+    - pattern: "\\{%\\s*include\\s+emoji_break\\.html.*?%\\}"
+      replacement: "\n---\n"
+```
+## Example
+Given a post at `_posts/2024-01-15-my-post.md`, after `jekyll build` you'll find:
+- `_site/2024/01/15/my-post.html` — the normal HTML output
+- `_site/2024/01/15/my-post.md` — clean Markdown with structured front matter
+The Markdown file looks like:
+```markdown
+---
+title: "My Post Title"
+date: 2024-01-15
+author: Your Name
+description: "A description of the post"
+tags: ["jekyll", "markdown"]
+url: https://example.com/2024/01/15/my-post.html
+---
+The raw markdown body of your post, with all includes
+stripped or replaced per your configuration.
+```
+## License
+MIT

data/lib/jekyll-third-audience/config.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module JekyllThirdAudience
+  class Config
+    DEFAULTS = {
+      "strip_includes" => [],
+      "replace_includes" => [],
+      "layouts" => ["post"],
+      "front_matter" => %w[title date author description tags url],
+    }.freeze
+    attr_reader :strip_includes, :replace_includes, :layouts, :front_matter_fields
+    def initialize(site_config)
+      cfg = DEFAULTS.merge(site_config.fetch("third_audience", {}))
+      @strip_includes = Array(cfg["strip_includes"])
+      @replace_includes = Array(cfg["replace_includes"])
+      @layouts = Array(cfg["layouts"])
+      @front_matter_fields = Array(cfg["front_matter"])
+    end
+  end
+end

data/lib/jekyll-third-audience/generator.rb ADDED Viewed

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+module JekyllThirdAudience
+  class Generator
+    def self.register!
+      Jekyll::Hooks.register :site, :post_write do |site|
+        config = Config.new(site.config)
+        site.posts.docs.each do |post|
+          next unless config.layouts.include?(post.data["layout"])
+          md_path = File.join(
+            site.dest,
+            File.dirname(post.url),
+            File.basename(post.url, File.extname(post.url)) + ".md"
+          )
+          front = build_front_matter(post, site, config)
+          body = extract_body(post, config)
+          FileUtils.mkdir_p(File.dirname(md_path))
+          File.write(md_path, front + body + "\n")
+        end
+      end
+    end
+    def self.build_front_matter(post, site, config)
+      lines = ["---"]
+      config.front_matter_fields.each do |field|
+        case field
+        when "title"
+          lines << "title: \"#{post.data['title'].to_s.gsub('"', '\\"')}\""
+        when "date"
+          date = post.data["date"]
+          lines << "date: #{date.respond_to?(:strftime) ? date.strftime('%Y-%m-%d') : date}"
+        when "author"
+          author = post.data["author"] || site.config["author"]
+          lines << "author: #{author}" if author
+        when "description"
+          desc = post.data["description"]
+          lines << "description: \"#{desc.to_s.gsub('"', '\\"')}\"" if desc
+        when "tags"
+          tags = post.data["tags"]
+          lines << "tags: #{tags.inspect}" if tags&.any?
+        when "url"
+          lines << "url: #{site.config['url']}#{post.url}"
+        else
+          value = post.data[field]
+          lines << "#{field}: #{value}" if value
+        end
+      end
+      lines << "---"
+      lines << ""
+      lines.join("\n") + "\n"
+    end
+    def self.extract_body(post, config)
+      raw = File.read(post.path, encoding: "utf-8")
+      body = raw.sub(/\A---.*?---\s*/m, "")
+      config.strip_includes.each do |inc|
+        pattern = Regexp.new("\\{%\\s*include\\s+#{Regexp.escape(inc)}\\s*%\\}")
+        body = body.gsub(pattern, "")
+      end
+      config.replace_includes.each do |rule|
+        pattern = Regexp.new(rule["pattern"])
+        body = body.gsub(pattern, rule["replacement"])
+      end
+      body.strip
+    end
+  end
+end

data/lib/jekyll-third-audience/meta_tag.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module JekyllThirdAudience
+  class MetaTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      page = context.registers[:page]
+      config = Config.new(site.config)
+      return "" unless config.layouts.include?(page["layout"])
+      url = page["url"].to_s
+      md_url = if url.end_with?("/")
+                 url + "index.md"
+               elsif url.end_with?(".html")
+                 url.sub(/\.html\z/, ".md")
+               else
+                 url + ".md"
+               end
+      title = page["title"].to_s.gsub('"', "&quot;")
+      %(<link rel="alternate" type="text/markdown" href="#{md_url}" title="#{title} (Markdown)" />)
+    end
+  end
+end

data/lib/jekyll-third-audience/version.rb ADDED Viewed

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

data/lib/jekyll-third-audience.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "jekyll"
+require "jekyll-third-audience/version"
+require "jekyll-third-audience/config"
+require "jekyll-third-audience/generator"
+require "jekyll-third-audience/meta_tag"
+module JekyllThirdAudience
+end
+JekyllThirdAudience::Generator.register!
+Liquid::Template.register_tag("third_audience_meta", JekyllThirdAudience::MetaTag)

metadata ADDED Viewed

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-third-audience
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Breunig
+bindir: bin
+cert_chain: []
+date: 2026-03-07 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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Jekyll plugin that generates clean Markdown copies of blog posts alongside
+  their HTML output, making your content accessible to AI agents — the 'third audience'
+  of the web. (People who like Markdown can use it too!)
+email:
+- dbreunig@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-third-audience.rb
+- lib/jekyll-third-audience/config.rb
+- lib/jekyll-third-audience/generator.rb
+- lib/jekyll-third-audience/meta_tag.rb
+- lib/jekyll-third-audience/version.rb
+homepage: https://github.com/dbreunig/jekyll-third-audience
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Generate clean Markdown versions of Jekyll posts for AI agents.
+test_files: []