jekyll-atom-feed 0.18.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2856d0204ad301147c97c8d41ebf461083782c7157fa64ee060cbf1e037d2133
+  data.tar.gz: 8a891b3f82b36ce614360fb44fa2cb0080474fc3c80a78016c76e80026428c00
+SHA512:
+  metadata.gz: c1d64a6aef3d8e06fecd61f056bc33084a198de42d71ad6dae88f70416cb091e19aedbb0db09c8bacbc865d61e25157d4181f12c01f49a4e48fa32ec35e2496e
+  data.tar.gz: 68fc9c2df214ad48c11eef52c2b55ba513d19a3eae913862e3cbb6c0a8b87bb99a4d0315445a41e3747a2ee6080b01ff0d5ad5a875652c4fd96b8971faf97964

data/History.markdown

@@ -0,0 +1,244 @@
+## HEAD
+
+## 0.18.0 / 2023-09-17
+
+  * Integrate Webfeeds for better Feedly integration
+  * Provide a template configuration option to overwrite feed.xml template
+
+### Development Fixes
+
+  * Upgrade to Rake 13 to fix master (#381)
+
+### Documentation
+
+  * Fix typos in Readme (#384)
+
+## 0.17.0 / 2022-10-14
+
+### Documentation
+
+  * Update CI status badge (#363)
+
+### Development Fixes
+
+  * Add Ruby 3.1 to the CI matrix (#365)
+
+### Minor Enhancements
+
+  * Allow disabling of jekyll-feed while in development (#370)
+
+## 0.16.0 / 2022-01-03
+
+### Minor Enhancements
+
+  * Add support for `page.description` in front matter to become entry `<summary>` (#297)
+
+### Bug Fixes
+
+  * Fold private methods into the `:render` method as local variables (#327)
+  * Check `post.categories` instead of `post.category` (#357)
+  * Switched xml_escape for `<![CDATA[]]>` for post content (#332)
+
+### Development Fixes
+
+  * Add Ruby 3.0 to CI (#337)
+  * Lock RuboCop to v1.18.x (#348)
+  * Add workflow to release gem via GH Action (#355)
+
+### Documentation
+
+  * Use `.atom` extension in documented examples since we write an Atom feed (#359)
+
+## 0.15.1 / 2020-10-04
+
+### Bug Fixes
+
+  * MetaTag: when encoding for XML special characters, handle non-string objects (#326)
+
+## 0.15.0 / 2020-07-10
+
+### Minor Enhancements
+
+  * Add support for drafts (#316)
+
+## 0.14.0 / 2020-06-24
+
+### Minor Enhancements
+
+  * add support for categories (#153) (#233)
+  * add support for tags (#264)
+  * Make posts limit configurable (#314)
+  * XML escape the title field of feed_meta (#306)
+
+### Bug Fixes
+
+  * Fix feed link when post title contains HTML (#305)
+
+### Development Fixes
+
+  * Use Dir to list source files (#309)
+  * Require Ruby &gt;=2.4.0 (#307)
+
+## 0.13.0 / 2019-11-13
+
+### Minor Enhancements
+
+  * Excerpt only flag (#287)
+  * Add media:content tag (#290)
+
+### Development Fixes
+
+  * test: use categories in post (#249)
+
+## 0.12.1 / 2019-03-23
+
+### Bug Fixes
+
+  * Re-introduce Ruby 2.3 support and test Jekyll 3.7+ (#272)
+
+## 0.12.0 / 2019-03-21
+
+  * Allow Jekyll v4 (still alpha)
+
+### Development Fixes
+
+  * style: fix offenses in specs (#248)
+  * dev: update CI and style settings (#258)
+  * Enable testing for Windows platform (#265)
+
+## 0.11.0 / 2018-09-09
+
+### Development Fixes
+
+  * Require Ruby 2.3 (#222)
+  * Refactor to remove redundant calls and variables (#240)
+
+### Minor Enhancements
+
+  * Categories and collections (#228)
+  * Remove check for older version of Jekyll (#234)
+
+## 0.10.0 / 2018-06-04
+
+### Bug Fixes
+
+  * Escape image URL (#209)
+
+### Development Fixes
+
+  * Rubocop 0.55 (#223)
+  * Bump Rubocop (#230)
+
+### Minor Enhancements
+
+  * Support Typhoeus 1.0 (#232)
+
+## 0.9.3 / 2018-02-04
+
+  * Define path with __dir (#187)
+  * Bump Ruby for Travis (#188)
+
+### Documentation
+
+  * Fix: Add note about using plugins instead of gems key (#197)
+  * Add documentation for disabling smartify filter (#205)
+  * Use `https` in more places. (#165)
+
+### Development Fixes
+
+  * Rubocop: Target Ruby 2.2 (#195)
+  * Test feeds that have a `site.lang` (#164)
+  * Test against Ruby 2.5 (#201)
+
+### Minor Enhancements
+
+  * fix <entry> template for posts with post.lang defined (#168)
+
+## 0.9.1 / 2017-02-17
+
+### Minor Enhancements
+
+  * Update feed.xml (#162)
+
+## 0.9.0 / 2017-02-16
+
+### Minor Enhancements
+
+  * Use absolute_url to generate the feed_meta url (#150)
+  * Make feed stylesheet optional (#149)
+  * Use new `normalize_whitespace` filter (#143)
+  * Feed entries must contain <author> (#152)
+  * Remove trailing slash from feed ID (#159)
+
+### Development Fixes
+
+  * Simplify minify regular expression (#141)
+  * Namespace as JekyllFeed (#151)
+  * rubocop -a (#160)
+
+### Bug Fixes
+
+  * Filter out drafts before limit (#154)
+
+## 0.8.0 / 2016-10-06
+
+  * Use filters to clean up Liquid template (#134)
+
+### Minor Enhancements
+
+  * Don't set @site.config["time"] on feed generation (#138)
+
+### pedantry
+
+  * Appease Rubocop (#139)
+
+## 0.7.2 / 2016-10-06
+
+  * Support `image.path` when `post.image` is an object (#137)
+
+## 0.7.1 / 2016-09-26
+
+  * Assign `url_base` before first usage (#133)
+
+## 0.7.0 / 2016-09-06
+
+  * Use type="html" to skirt around double escaping problem (#127)
+
+## 0.6.0 / 2016-07-08
+
+  * Cleanup `post_author` logic (#113)
+  * Add XML stylesheet example with XSLT (#119)
+  * DRY up and add more doc (#120)
+  * Use smartify filter (#117)
+
+## 0.5.1 / 2016-04-18
+
+  * Fix mangling of whitespace when `site.lang` is set (#110)
+
+## 0.5.0 / 2016-04-13
+
+  * Consolidate regexps for stripping whitespace (#82)
+  * Only test against Jekyll 3 (#99)
+  * Think about how i18n might work (#75)
+  * Find author by reference (#106)
+  * Drop support for Jekyll 2 (#105)
+  * Add support for post image (#104)
+
+### Minor Enhancements
+
+  * Use Module#method_defined? (#83)
+  * Use site.title for meta tag if available (#100)
+
+### Development Fixes
+
+  * Do not require [**jekyll-last-modified-at**](https://github.com/gjtorikian/jekyll-last-modified-at) in tests (#87)
+  * Add Rubocop (#81)
+  * Correct typo in tests (#102)
+  * Simplify testing feed_meta tag (#101)
+  * Quiet known warnings in tests (#103)
+
+## 0.4.0 / 2015-12-30
+
+  * Feed uses `site.title`, or `site.name` if `title` doesn't exist (#72)
+  * Replace newlines with spaces in `title` and `summary` elements (#67)
+  * Properly render post content with Jekyll (#73)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-present Ben Balter and jekyll-feed and jekyll-atom-feed contributors
+
+MIT License
+
+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,285 @@
+# Jekyll Feed plugin
+
+A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts
+
+[![Continuous Integration](https://github.com/bautisflow/jekyll-atom-feed/actions/workflows/ruby.yml/badge.svg)](https://github.com/bautisflow/jekyll-atom-feed/actions/workflows/ruby.yml) [![Gem Version](https://badge.fury.io/rb/jekyll-atom-feed.svg)](https://badge.fury.io/rb/jekyll-atom-feed)
+
+## Installation
+
+Add this line to your site's Gemfile:
+
+```ruby
+gem 'jekyll-atom-feed'
+```
+
+And then add this line to your site's `_config.yml`:
+
+```yml
+plugins:
+  - jekyll-atom-feed
+```
+
+:warning: If you are using Jekyll < 3.5.0 use the `gems` key instead of `plugins`.
+
+## Usage
+
+The plugin will automatically generate an Atom feed at `/feed.xml`.
+
+### Optional configuration options
+
+The plugin will automatically use any of the following configuration variables, if they are present in your site's `_config.yml` file.
+
+* `title` or `name` - The title of the site, e.g., "My awesome site"
+* `description` - A longer description of what your site is about, e.g., "Where I blog about Jekyll and other awesome things"
+* `url` - The URL to your site, e.g., `https://example.com`. If none is provided, the plugin will try to use `site.github.url`.
+* `author` - Global author information (see below)
+
+If you want to enrich your feed for [Feedly](https://feedly.com), create the following object with any of these optional values:
+```yml
+webfeeds:
+  icon: # path to a 96x96 favicon
+  logo: # path to a 30px height svg
+  cover: # path to a large 16:9 banner image
+  accent_color: # hex colour without the hash
+  related: # true = show other stories from your feed under yours
+  analytics: # Google Analytics UA-x tracking ID
+```
+
+### Already have a feed path?
+
+Do you already have an existing feed someplace other than `/feed.xml`, but are on a host like GitHub Pages that doesn't support machine-friendly redirects? If you simply swap out `jekyll-atom-feed` for your existing template, your existing subscribers won't continue to get updates. Instead, you can specify a non-default path via your site's config.
+
+```yml
+feed:
+  path: /blog/feed.atom
+```
+
+To note, you shouldn't have to do this unless you already have a feed you're using, and you can't or wish not to redirect existing subscribers.
+
+### Optional front matter
+
+The plugin will use the following post metadata, automatically generated by Jekyll, which you can override via a post's YAML front matter:
+
+* `date`
+* `title`
+* `excerpt`
+* `id`
+* `category`
+* `tags`
+
+Additionally, the plugin will use the following values, if present in a post's YAML front matter:
+
+* `image` - URL of an image that is representative of the post (can also be passed as `image.path`)
+
+* `author` - The author of the post, e.g., "Dr. Jekyll". If none is given, feed readers will look to the feed author as defined in `_config.yml`. Like the feed author, this can also be an object or a reference to an author in `_data/authors.yml` (see below).
+
+* `description` - A short description of the post.
+
+### Author information
+
+*TL;DR: In most cases, put `author: [your name]` in the document's front matter, for sites with multiple authors. If you need something more complicated, read on.*
+
+There are several ways to convey author-specific information. Author information is found in the following order of priority:
+
+1. An `author` object, in the document's front matter, e.g.:
+
+  ```yml
+  author:
+    twitter: benbalter
+  ```
+
+2. An `author` object, in the site's `_config.yml`, e.g.:
+
+  ```yml
+  author:
+    twitter: benbalter
+  ```
+
+3. `site.data.authors[author]`, if an author is specified in the document's front matter, and a corresponding key exists in `site.data.authors`. E.g., you have the following in the document's front matter:
+
+  ```yml
+  author: benbalter
+  ```
+
+  And you have the following in `_data/authors.yml`:
+
+  ```yml
+  benbalter:
+    picture: /img/benbalter.png
+    twitter: jekyllrb
+
+  potus:
+    picture: /img/potus.png
+    twitter: whitehouse
+  ```
+
+  In the above example, the author `benbalter`'s Twitter handle will be resolved to `@jekyllrb`. This allows you to centralize author information in a single `_data/authors` file for site with many authors that require more than just the author's username.
+
+  *Pro-tip: If `authors` is present in the document's front matter as an array (and `author` is not), the plugin will use the first author listed.*
+
+4. An author in the document's front matter (the simplest way), e.g.:
+
+  ```yml
+  author: benbalter
+  ```
+
+5. An author in the site's `_config.yml`, e.g.:
+
+  ```yml
+  author: benbalter
+  ```
+
+### Meta tags
+
+The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. Simply place `{% feed_meta %}` someplace in your template's `<head>` section, to output the necessary metadata.
+
+### SmartyPants
+
+The plugin uses [Jekyll's `smartify` filter](https://jekyllrb.com/docs/templates/) for processing the site title and post titles. This will translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a title.
+
+Jekyll's `smartify` filter uses [kramdown](https://kramdown.gettalong.org/options.html) as a processor.  Accordingly, if you do not want "smart" typographic punctuation, disabling them in kramdown in your `_config.yml` will disable them in your feed. For example:
+
+   ```yml
+   kramdown:
+     smart_quotes:               apos,apos,quot,quot
+     typographic_symbols:        {hellip: ...}
+   ```
+
+### Custom styling
+
+Want to style what your feed looks like in the browser? When a XSLT Styleheet file named `feed.xslt.xml` exists at the root of your repository, a link to this stylesheet is added to the generated feed.
+
+### Custom source template
+
+You can specify your own source `feed.xml` if you like to modify the content of the generated feed. Simply define a template path to your xml source file:
+
+```yaml
+feed:
+  template: _layouts/feed.xml
+```
+
+## Why Atom, and not RSS?
+
+Great question. In short, Atom is a better format. Think of it like RSS 3.0. For more information, see [this discussion on why we chose Atom over RSS 2.0](https://github.com/jekyll/jekyll-rss-feed/issues/2).
+
+## Categories
+
+Jekyll Feed can generate feeds for each category. Simply define which categories you'd like feeds for in your config:
+
+```yml
+feed:
+  categories:
+    - news
+    - updates
+```
+
+## Posts limit
+
+By default the plugin limits the number of posts in the feed to 10. Simply define a new limit in your config:
+
+```yml
+feed:
+  posts_limit: 20
+```
+
+## Collections
+
+Jekyll Feed can generate feeds for collections other than the Posts collection. This works best for chronological collections (e.g., collections with dates in the filenames). Simply define which collections you'd like feeds for in your config:
+
+```yml
+feed:
+  collections:
+    - changes
+```
+
+By default, collection feeds will be outputted to `/feed/<COLLECTION>.xml`. If you'd like to customize the output path, specify a collection's custom path as follows:
+
+```yml
+feed:
+  collections:
+    changes:
+      path: "/changes.atom"
+```
+
+Finally, collections can also have category feeds that are outputted as `/feed/<COLLECTION>/<CATEGORY>.xml`. Specify categories like so:
+
+```yml
+feed:
+  collections:
+    changes:
+      path: "/changes.atom"
+      categories:
+        - news
+        - updates
+```
+
+## Excerpt Only flag
+
+Optional flag `excerpt_only` allows you to exclude post content from the Atom feed. Default value is `false` for backward compatibility.
+
+When in `config.yml` is `true` then all posts in feed will be without `<content>` tags.
+
+```yml
+feed:
+  excerpt_only: true
+```
+
+The same flag can be used directly in post file. It will disable `<content>` tag for selected post.
+Settings in post file have higher priority than in config file.
+
+## Tags
+
+To automatically generate feeds for each tag you apply to your posts you can add a tags setting to your config:
+
+```yml
+feed:
+  tags: true
+```
+
+If there are tags you don't want included in this auto generation you can exclude them
+
+```yml
+feed:
+  tags:
+    except:
+      - tag-to-exclude
+      - another-tag
+```
+
+If you wish to change the location of these auto generated feeds (`/feed/by_tag/<TAG>.xml` by default) you can provide an alternative folder for them to live in.
+
+```yml
+feed:
+  tags:
+    path: "alternative/path/for/tags/feeds/"
+```
+
+If you only want to generate feeds for a few tags you can also set this.
+
+```yml
+feed:
+  tags:
+    only:
+      - tag-to-include
+      - another-tag
+```
+
+Note that if you include a tag that is excluded a feed will not be generated for it.
+
+## Skip development
+
+Use `disable_in_development: true` if you want to turn off feed generation when `jekyll.environment == "development"`,
+but don't want to remove the plugin (so you don't accidentally commit the removal). Default value is `false`.
+
+```yml
+feed:
+  disable_in_development: true
+```
+
+## Contributing
+
+1. Fork it (https://github.com/bautisflow/jekyll-atom-feed/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/jekyll-atom-feed/feed.xml

@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="utf-8"?>
+{% if page.xsl %}
+  <?xml-stylesheet type="text/xml" href="{{ '/feed.xslt.xml' | absolute_url }}"?>
+{% endif %}
+<feed xmlns="http://www.w3.org/2005/Atom" {% if site.webfeeds %} xmlns:webfeeds="http://webfeeds.org/rss/1.0"{% endif %} {% if site.lang %}xml:lang="{{ site.lang }}"{% endif %}>
+  <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
+  <link href="{{ page.url | absolute_url }}" rel="self" type="application/atom+xml" />
+  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" {% if site.lang %}hreflang="{{ site.lang }}" {% endif %}/>
+  <updated>{{ site.time | date_to_xmlschema }}</updated>
+  <id>{{ page.url | absolute_url | xml_escape }}</id>
+
+  {% assign title = site.title | default: site.name %}
+  {% if page.collection != "posts" %}
+    {% assign collection = page.collection | capitalize %}
+    {% assign title = title | append: " | " | append: collection %}
+  {% endif %}
+  {% if page.category %}
+    {% assign category = page.category | capitalize %}
+    {% assign title = title | append: " | " | append: category %}
+  {% endif %}
+
+  {% if title %}
+    <title type="html">{{ title | smartify | xml_escape }}</title>
+  {% endif %}
+
+  {% if site.description %}
+    <subtitle>{{ site.description | xml_escape }}</subtitle>
+  {% endif %}
+
+  {% if site.author %}
+    <author>
+        <name>{{ site.author.name | default: site.author | xml_escape }}</name>
+      {% if site.author.email %}
+        <email>{{ site.author.email | xml_escape }}</email>
+      {% endif %}
+      {% if site.author.uri %}
+        <uri>{{ site.author.uri | xml_escape }}</uri>
+      {% endif %}
+    </author>
+  {% endif %}
+
+  {% if site.webfeeds %}
+    {% if site.webfeeds.icon %}<webfeeds:icon>{{ site.webfeeds.icon }}</webfeeds:icon>{% endif %}
+    {% if site.webfeeds.logo %}<webfeeds:logo>{{ site.webfeeds.logo }}</webfeeds:logo>{% endif %}
+    {% if site.webfeeds.cover %}<webfeeds:cover>{{ site.webfeeds.cover }}</webfeeds:cover>{% endif %}
+    {% if site.webfeeds.accent_color %}<webfeeds:accentColor>{{ site.webfeeds.accent_color }}</webfeeds:accentColor>{% endif %}
+    {% if site.webfeeds.related %}<webfeeds:related layout="card" target="browser"/>{% endif %}
+    {% if site.webfeeds.analytics %}<webfeeds:analytics id="{{ site.webfeeds.analytics }}" engine="GoogleAnalytics" />{% endif %}
+  {% endif %}
+
+  {% if page.tags %}
+    {% assign posts = site.tags[page.tags] %}
+  {% else %}
+    {% assign posts = site[page.collection] %}
+  {% endif %}
+  {% if page.category %}
+    {% assign posts = posts | where: "categories", page.category %}
+  {% endif %}
+  {% unless site.show_drafts %}
+    {% assign posts = posts | where_exp: "post", "post.draft != true" %}
+  {% endunless %}
+  {% assign posts = posts | sort: "date" | reverse %}
+  {% assign posts_limit = site.feed.posts_limit | default: 10 %}
+  {% for post in posts limit: posts_limit %}
+    <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
+      {% assign post_title = post.title | smartify | strip_html | normalize_whitespace | xml_escape %}
+
+      <title type="html">{{ post_title }}</title>
+      <link href="{{ post.url | absolute_url }}" rel="alternate" type="text/html" title="{{ post_title }}" />
+      <published>{{ post.date | date_to_xmlschema }}</published>
+      <updated>{{ post.last_modified_at | default: post.date | date_to_xmlschema }}</updated>
+      <id>{{ post.id | absolute_url | xml_escape }}</id>
+      {% assign excerpt_only = post.feed.excerpt_only | default: site.feed.excerpt_only %}
+      {% unless excerpt_only %}
+        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}"><![CDATA[{{ post.content | strip }}]]></content>
+      {% endunless %}
+
+      {% assign post_author = post.author | default: post.authors[0] | default: site.author %}
+      {% assign post_author = site.data.authors[post_author] | default: post_author %}
+      {% assign post_author_email = post_author.email | default: nil %}
+      {% assign post_author_uri = post_author.uri | default: nil %}
+      {% assign post_author_name = post_author.name | default: post_author %}
+
+      <author>
+          <name>{{ post_author_name | default: "" | xml_escape }}</name>
+        {% if post_author_email %}
+          <email>{{ post_author_email | xml_escape }}</email>
+        {% endif %}
+        {% if post_author_uri %}
+          <uri>{{ post_author_uri | xml_escape }}</uri>
+        {% endif %}
+      </author>
+
+      {% if post.category %}
+        <category term="{{ post.category | xml_escape }}" />
+      {% elsif post.categories %}
+        {% for category in post.categories %}
+          <category term="{{ category | xml_escape }}" />
+        {% endfor %}
+      {% endif %}
+
+      {% for tag in post.tags %}
+        <category term="{{ tag | xml_escape }}" />
+      {% endfor %}
+
+      {% assign post_summary = post.description | default: post.excerpt %}
+      {% if post_summary and post_summary != empty %}
+        <summary type="html"><![CDATA[{{ post_summary | strip_html | normalize_whitespace }}]]></summary>
+      {% endif %}
+
+      {% assign post_image = post.image.path | default: post.image %}
+      {% if post_image %}
+        {% unless post_image contains "://" %}
+          {% assign post_image = post_image | absolute_url %}
+        {% endunless %}
+        <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image | xml_escape }}" />
+        <media:content medium="image" url="{{ post_image | xml_escape }}" xmlns:media="http://search.yahoo.com/mrss/" />
+      {% endif %}
+    </entry>
+  {% endfor %}
+</feed>

data/lib/jekyll-atom-feed/generator.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module JekyllFeed
+  class Generator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      @site = site
+      if disabled_in_development?
+        Jekyll.logger.info "Jekyll Feed:", "Skipping feed generation in development"
+        return
+      end
+      collections.each do |name, meta|
+        Jekyll.logger.info "Jekyll Feed:", "Generating feed for #{name}"
+        (meta["categories"] + [nil]).each do |category|
+          path = feed_path(:collection => name, :category => category)
+          next if file_exists?(path)
+
+          @site.pages << make_page(path, :collection => name, :category => category)
+        end
+      end
+      generate_feed_by_tag if config["tags"] && !@site.tags.empty?
+    end
+
+    private
+
+    # Matches all whitespace that follows
+    #   1. A '>', which closes an XML tag or
+    #   2. A '}', which closes a Liquid tag
+    # We will strip all of this whitespace to minify the template
+    MINIFY_REGEX = %r!(?<=>|})\s+!.freeze
+
+    # Returns the plugin's config or an empty hash if not set
+    def config
+      @config ||= @site.config["feed"] || {}
+    end
+
+    # Determines the destination path of a given feed
+    #
+    # collection - the name of a collection, e.g., "posts"
+    # category - a category within that collection, e.g., "news"
+    #
+    # Will return "/feed.xml", or the config-specified default feed for posts
+    # Will return `/feed/category.xml` for post categories
+    # WIll return `/feed/collection.xml` for other collections
+    # Will return `/feed/collection/category.xml` for other collection categories
+    def feed_path(collection: "posts", category: nil)
+      prefix = collection == "posts" ? "/feed" : "/feed/#{collection}"
+      return "#{prefix}/#{category}.xml" if category
+
+      collections.dig(collection, "path") || "#{prefix}.xml"
+    end
+
+    # Returns a hash representing all collections to be processed and their metadata
+    # in the form of { collection_name => { categories = [...], path = "..." } }
+    def collections
+      return @collections if defined?(@collections)
+
+      @collections = case config["collections"]
+                     when Array
+                       config["collections"].map { |c| [c, {}] }.to_h
+                     when Hash
+                       config["collections"]
+                     else
+                       {}
+                     end
+
+      @collections = normalize_posts_meta(@collections)
+      @collections.each_value do |meta|
+        meta["categories"] = (meta["categories"] || []).to_set
+      end
+
+      @collections
+    end
+
+    def generate_feed_by_tag
+      tags_config = config["tags"]
+      tags_config = {} unless tags_config.is_a?(Hash)
+
+      except    = tags_config["except"] || []
+      only      = tags_config["only"] || @site.tags.keys
+      tags_pool = only - except
+      tags_path = tags_config["path"] || "/feed/by_tag/"
+
+      generate_tag_feed(tags_pool, tags_path)
+    end
+
+    def generate_tag_feed(tags_pool, tags_path)
+      tags_pool.each do |tag|
+        # allow only tags with basic alphanumeric characters and underscore to keep
+        # feed path simple.
+        next if %r![^a-zA-Z0-9_]!.match?(tag)
+
+        Jekyll.logger.info "Jekyll Feed:", "Generating feed for posts tagged #{tag}"
+        path = "#{tags_path}#{tag}.xml"
+        next if file_exists?(path)
+
+        @site.pages << make_page(path, :tags => tag)
+      end
+    end
+
+    # Path to feed.xml template file
+    def feed_source_path
+      @feed_source_path = config["template"] if config["template"]
+      @feed_source_path ||= File.expand_path "feed.xml", __dir__
+    end
+
+    def feed_template
+      @feed_template ||= File.read(feed_source_path).gsub(MINIFY_REGEX, "")
+    end
+
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
+      File.exist? @site.in_source_dir(file_path)
+    end
+
+    # Generates contents for a file
+
+    def make_page(file_path, collection: "posts", category: nil, tags: nil)
+      PageWithoutAFile.new(@site, __dir__, "", file_path).tap do |file|
+        file.content = feed_template
+        file.data.merge!(
+          "layout"     => nil,
+          "sitemap"    => false,
+          "xsl"        => file_exists?("feed.xslt.xml"),
+          "collection" => collection,
+          "category"   => category,
+          "tags"       => tags
+        )
+        file.output
+      end
+    end
+
+    # Special case the "posts" collection, which, for ease of use and backwards
+    # compatability, can be configured via top-level keys or directly as a collection
+    def normalize_posts_meta(hash)
+      hash["posts"] ||= {}
+      hash["posts"]["path"] ||= config["path"]
+      hash["posts"]["categories"] ||= config["categories"]
+      config["path"] ||= hash["posts"]["path"]
+      hash
+    end
+
+    def disabled_in_development?
+      config && config["disable_in_development"] && Jekyll.env == "development"
+    end
+  end
+end

data/lib/jekyll-atom-feed/meta-tag.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JekyllFeed
+  class MetaTag < Liquid::Tag
+    # Use Jekyll's native relative_url filter
+    include Jekyll::Filters::URLFilters
+
+    def render(context)
+      # Jekyll::Filters::URLFilters requires `@context` to be set in the environment.
+      @context = context
+
+      config = context.registers[:site].config
+      path   = config.dig("feed", "path") || "feed.xml"
+      title  = config["title"] || config["name"]
+
+      attributes = {
+        :type => "application/atom+xml",
+        :rel  => "alternate",
+        :href => absolute_url(path),
+      }
+      attributes[:title] = title if title
+
+      attrs = attributes.map { |k, v| "#{k}=#{v.to_s.encode(:xml => :attr)}" }.join(" ")
+      "<link #{attrs} />"
+    end
+  end
+end

data/lib/jekyll-atom-feed/page-without-a-file.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JekyllFeed
+  class PageWithoutAFile < Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/jekyll-atom-feed/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Feed
+    VERSION = "0.18.0"
+  end
+end

data/lib/jekyll-atom-feed.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "fileutils"
+require "jekyll-atom-feed/generator"
+
+module JekyllFeed
+  autoload :MetaTag,          "jekyll-atom-feed/meta-tag"
+  autoload :PageWithoutAFile, "jekyll-atom-feed/page-without-a-file.rb"
+end
+
+Liquid::Template.register_tag "feed_meta", JekyllFeed::MetaTag

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-atom-feed
+version: !ruby/object:Gem::Version
+  version: 0.18.0
+platform: ruby
+authors:
+- Jaime Bautista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- bautisflow@github.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- History.markdown
+- LICENSE.txt
+files:
+- History.markdown
+- LICENSE.txt
+- README.md
+- lib/jekyll-atom-feed.rb
+- lib/jekyll-atom-feed/feed.xml
+- lib/jekyll-atom-feed/generator.rb
+- lib/jekyll-atom-feed/meta-tag.rb
+- lib/jekyll-atom-feed/page-without-a-file.rb
+- lib/jekyll-atom-feed/version.rb
+homepage: https://github.com/bautisflow/jekyll-atom-feed
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts
+test_files: []