{"id":13411874,"url":"https://github.com/html2rss/html2rss-configs","last_synced_at":"2025-03-14T17:31:15.129Z","repository":{"id":38215629,"uuid":"192089253","full_name":"html2rss/html2rss-configs","owner":"html2rss","description":"📇 A growing collection of html2rss feed configs. Generate configs with the handy generator.","archived":false,"fork":false,"pushed_at":"2024-05-17T05:31:19.000Z","size":343,"stargazers_count":20,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-17T06:34:34.436Z","etag":null,"topics":["configuration","dynamic-parameters","feed","feed-configs","html2rss","html2rss-configs","html2rss-web","presets","scraping"],"latest_commit_sha":null,"homepage":"https://html2rss.github.io/configs/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/html2rss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"gildesmarais"}},"created_at":"2019-06-15T14:40:49.000Z","updated_at":"2024-07-23T11:38:46.589Z","dependencies_parsed_at":"2023-10-04T20:51:18.875Z","dependency_job_id":"a11f96f2-f278-43c8-aac0-0bbf2bb17f92","html_url":"https://github.com/html2rss/html2rss-configs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/html2rss%2Fhtml2rss-configs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/html2rss%2Fhtml2rss-configs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/html2rss%2Fhtml2rss-configs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/html2rss%2Fhtml2rss-configs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/html2rss","download_url":"https://codeload.github.com/html2rss/html2rss-configs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243618683,"owners_count":20320274,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["configuration","dynamic-parameters","feed","feed-configs","html2rss","html2rss-configs","html2rss-web","presets","scraping"],"created_at":"2024-07-30T20:01:17.854Z","updated_at":"2025-03-14T17:31:11.357Z","avatar_url":"https://github.com/html2rss.png","language":"Ruby","readme":"![html2rss logo](https://github.com/html2rss/html2rss/raw/master/support/logo.png)\n\n# html2rss-configs\n\n✌️ This repository contains [`html2rss`](https://github.com/html2rss/html2rss) _feed configs_ for many websites.\n👉 Find all _feed configs_ in the [`configs/` directory](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs).\n☝️ A handy usage method is via [`html2rss-web`](https://github.com/html2rss/html2rss-web).\n💪 Contributions are more than welcome!\n[Fork this repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo),\nadd your _feed config_ and\n[create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).\n\n## Contributing\n\nThe html2rss \"ecosystem\" is a community project. We welcome contributions of all kinds. This includes new feed configs, suggesting and implementing features, providing bug fixes, documentation improvements, and any other kind of help.\n\n### Adding a new feed config\n\nWhich way you choose to add a new feed config is up to you. You can do it manually or risk the \"wizard-like\" generator. Please [submit a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)!\n\nAfter you're done, you can test your feed config by running `bundle exec html2rss feed lib/html2rss/configs/\u003cdomainname.tld\u003e/\u003cpath\u003e.yml`.\n\n#### Prefered way: manually\n\n1. Fork this repo and run `bundle install` (you need to have Ruby \u003e= 3.1 installed).\n2. Create a new folder and file following ths convention: `lib/html2rss/configs/\u003cdomainname.tld\u003e/\u003cpath\u003e.yml`\n3. Create the feed config in the `\u003cpath\u003e.yml` file.\n4. Add this spec file in the `spec/html2rss/configs/\u003cdomainname.tld\u003e/\u003cpath\u003e_spec.rb` file.\n\n```ruby\n  RSpec.describe '\u003cdomainname.tld\u003e/\u003cpath\u003e' do\n    include_examples 'config.yml', described_class\n  end\n```\n\n#### Using the \"wizard-like\" generator\n\nThere's was a try to build a wizard like TUI based generator for that! 🆒 It hasn't seen much love, tho, but it might gets you going or crash in the middle of the process.\n\n1. Fork this repo and run `bundle install` (you need to have Ruby \u003e= 3.1 installed).\n2. Start the generator by typing: `bin/generator`\n3. Build your feed config and answer 'y' in the last step to create the files.\n4. Optionally, edit the created files. Read [`html2rss`'s README](https://github.com/html2rss/html2rss/blob/master/README.md) to see what is possible or browse [existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs) for inspiration.\n5. To test, run:\n   `bundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever`\n\n## Using dynamic parameters in `channel` attributes\n\nWhen you're using dynamic parameters, you have to provide the parameters to the spec, too:\n\n```ruby\ninclude_examples 'config.yml', 'domainname.tld/whatever.yml', id: 42\n```\n\nCLI usage:\n\n```sh\nbundle exec html2rss feed lib/html2rss/configs/domainname.tld/whatever id=42\n```\n\n## Programmatic usage\n\nAdd to your Gemfile:\n\n```ruby\ngem 'html2rss-configs', git: 'https://github.com/html2rss/html2rss-configs.git'\n```\n\nUse it in your code:\n\n```ruby\nrequire 'html2rss/configs'\n\nconfig = Html2rss::Configs.find_by_name('domainname.tld/whatever')\n```\n\nThis will return the _feed config_.\n\n## Usage with `html2rss-web`\n\nIf you're running [`html2rss-web`](https://github.com/html2rss/html2rss-web),\nyou have nothing more to do! 🎉 Just request them from your instance at path: `/\u003cdomainname.tld/path\u003e.rss` and you'll be served the RSS.\n\n## CI: Building on the CI\n\nModifying existing or adding new _feed configs_ will trigger the CI to fetch the feed\nand check for the presence of feed items.\n","funding_links":["https://github.com/sponsors/gildesmarais"],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhtml2rss%2Fhtml2rss-configs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhtml2rss%2Fhtml2rss-configs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhtml2rss%2Fhtml2rss-configs/lists"}