New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use jekyll-feed to generate the default site's RSS feed #5196

Merged
merged 1 commit into from Aug 6, 2016

Conversation

Projects
None yet
6 participants
@benbalter
Contributor

benbalter commented Aug 3, 2016

Rather than encouraging each new Jekyll use to hard code a RSS feed template in their generated site (where it's frozen in carbonite and will never receive bug fixes or new features), we should instead rely on the office Jekyll Feed plugin to generate the default site's RSS feed.

As an added benefit, it gives us an opportunity to show users how to use themes (and further hints that they exist and that they should use them, rather than hard-coding templates they found on the internet).

Practically, Jekyll Feed is a drop in replacement, but is a bit more battle tested, in that it handles a few edge cases surfaced from being used in some many different environments, supports relative URLs in posts, includes author metadata, post summaries, and images (all if present).

You can see the Jekyll Feed Template to compare.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Aug 3, 2016

Member

Nokogiri has C dependencies, so I'm 👎 on this. It will break the default site for most Windows users.

Member

parkr commented Aug 3, 2016

Nokogiri has C dependencies, so I'm 👎 on this. It will break the default site for most Windows users.

@benbalter

This comment has been minimized.

Show comment
Hide comment
@benbalter

benbalter Aug 3, 2016

Contributor

It will break the default site for most Windows users.

Does it matter that it's a dev dependency thus shouldn't be a problem for building the site, only for contributing to jekyll-feed?

Contributor

benbalter commented Aug 3, 2016

It will break the default site for most Windows users.

Does it matter that it's a dev dependency thus shouldn't be a problem for building the site, only for contributing to jekyll-feed?

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Aug 3, 2016

Member

Does it matter that it's a dev dependency thus shouldn't be a problem for building the site, only for contributing to jekyll-feed?

YOU ARE TOTALLY RIGHT. My bad. I just took a look at the RubyGems.org page, saw it and left that comment. Sorry!

LGTM.

Member

parkr commented Aug 3, 2016

Does it matter that it's a dev dependency thus shouldn't be a problem for building the site, only for contributing to jekyll-feed?

YOU ARE TOTALLY RIGHT. My bad. I just took a look at the RubyGems.org page, saw it and left that comment. Sorry!

LGTM.

@benbalter

This comment has been minimized.

Show comment
Hide comment
@benbalter

benbalter Aug 3, 2016

Contributor

🤘 Will give it a bit to sit, in case others want to weigh in.

Contributor

benbalter commented Aug 3, 2016

🤘 Will give it a bit to sit, in case others want to weigh in.

@benbalter

This comment has been minimized.

Show comment
Hide comment
@benbalter

benbalter Aug 3, 2016

Contributor

Also to note, I purposely did not use {% feed_meta %} in the template, as that would break the build if for some reason jekyll-feed wasn't loaded (e.g., no bundler, removed from Gemfile, etc.). Better to 404 than to fail the build.

On a related note, it'd be awesome to be able to check if a plugin's installed, e.g., {% if site.plugins | include: "jekyll-feed" %}.

Contributor

benbalter commented Aug 3, 2016

Also to note, I purposely did not use {% feed_meta %} in the template, as that would break the build if for some reason jekyll-feed wasn't loaded (e.g., no bundler, removed from Gemfile, etc.). Better to 404 than to fail the build.

On a related note, it'd be awesome to be able to check if a plugin's installed, e.g., {% if site.plugins | include: "jekyll-feed" %}.

@pathawks

This comment has been minimized.

Show comment
Hide comment
@pathawks

pathawks Aug 3, 2016

Member

Cool 👍

Member

pathawks commented Aug 3, 2016

Cool 👍

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Aug 3, 2016

Contributor

I'm 👍, LGTM.

Contributor

envygeeks commented Aug 3, 2016

I'm 👍, LGTM.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Aug 6, 2016

Member

@jekyllbot: merge +bug

Member

parkr commented Aug 6, 2016

@jekyllbot: merge +bug

@jekyllbot jekyllbot merged commit 61eda2e into master Aug 6, 2016

2 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jekyll/lgtm Approved by @parkr and @envygeeks.

@jekyllbot jekyllbot added bug fix labels Aug 6, 2016

@jekyllbot jekyllbot deleted the site-template-jekyll-feed branch Aug 6, 2016

jekyllbot added a commit that referenced this pull request Aug 6, 2016

@pathawks

This comment has been minimized.

Show comment
Hide comment
@pathawks

pathawks Dec 4, 2017

Member

I wonder if jekyll-feed should either only be included in the Gemfile, or required in the Gemfile but not in the jekyll-plugins group.

I was confused when I removed jekyll-feed from _config.yml but the feed was still generated.

Member

pathawks commented Dec 4, 2017

I wonder if jekyll-feed should either only be included in the Gemfile, or required in the Gemfile but not in the jekyll-plugins group.

I was confused when I removed jekyll-feed from _config.yml but the feed was still generated.

@ashmaroli

This comment has been minimized.

Show comment
Hide comment
@ashmaroli

ashmaroli Dec 4, 2017

Member

I vote for required in the `Gemfile` but not in the `:jekyll-plugins` group.

Member

ashmaroli commented Dec 4, 2017

I vote for required in the `Gemfile` but not in the `:jekyll-plugins` group.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment