jekyll / jekyll-feed

:memo: A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts
MIT License
826 stars 201 forks source link

Extension .atom in README.md is bad advise; will be served with wrong media type by web servers #401

Closed michaelnordmeyer closed 5 months ago

michaelnordmeyer commented 5 months ago

The change in https://github.com/jekyll/jekyll-feed/pull/359 changed feed name examples to .atom.

This is bad advise, because web servers will serve this file extension not as text/xml, application/xml, nor application/atom+xml, but, at least in nginx’s case, as application/octet-stream. That's why jekyll-feed named the optional feed XSLT feed.xslt.xml, because xml file extensions will by default served as text/xml.

While this can be configured server-side, the "just upload static files and it works out of the box" mantra is broken.

michaelnordmeyer commented 5 months ago

Never mind, it was a configuration issue on my side. I'm sorry.