html2rss-configs

✌️This repository contains html2rss feed configs for many websites. 👉Find all feed configs in the configs/ directory. ☝️A handy usage method is via html2rss-web. 💪 Contributions are more than welcome! Fork this repository, add your feed config and create a pull request.

Adding a new feed config

There's a generator for that! 🆒

1. Fork this repo and run bundle install (you need to have Ruby >= 3.1 installed).
2. Start the generator by typing: bin/generator
3. Build your feed config and answer 'y' in the last step to create the files.
4. Optionally, edit the created files. Read html2rss's README what is possible or browse existing configs for inspiration.
5. To test, run: bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever

Using dynamic parameters in channel attributes

When you're using dynamic parameters, you have to provide the parameters to the spec, too:

include_examples 'config.yml', 'domainname.tld/whatever.yml', id: 42

CLI usage:

bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever id=42

Programmatic usage

Add to your Gemfile:

gem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git'

Use it in your code:

require 'html2rss/configs'

config = Html2rss::Configs.find_by_name('domainname.tld/whatever')

This will return the feed config.

Usage with html2rss-web

If you're running html2rss-web, you have nothing more to do! 🎉

Building on the CI

Modifying existing or adding new feed configs will trigger the CI to fetch the feed and check for the presence of feed items.

See .travis.yml -> script which commands execute during build.