Skip to content

Provide a template configuration option to overwrite feed.xml template #362

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Provide a template configuration option to overwrite feed.xml template #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,15 @@ Jekyll's `smartify` filter uses [kramdown](https://kramdown.gettalong.org/option

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).
Expand Down
1 change: 1 addition & 0 deletions lib/jekyll-feed/generator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ def generate_tag_feed(tags_pool, tags_path)

# 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

Expand Down