Ruby Gem
This section provides comprehensive documentation for the html2rss Ruby gem.
If you are looking for the stable machine-readable contract for config authoring, use the JSON Schema exported by the core repo:
- Repository file:
html2rss-config.schema.json - CLI export:
html2rss schema(also--write,--no-pretty) - Runtime validation:
html2rss validate config.ymlorHtml2rss::Config.validate - Ruby discovery:
Html2rss::Config.json_schema/Html2rss::Config.schema_path
The exported schema covers client-side validation. Runtime validation remains authoritative for dynamic cross-field checks such as selector-key references. Contributors regenerating the checked-in artifact should run bundle exec rake config:schema in the core repo.
Getting Started
Section titled “Getting Started”If you are getting started with html2rss, we recommend starting with the first tutorial.
Documentation Sections
Section titled “Documentation Sections”- Tutorials: Step-by-step guides to help you get started with
html2rss. - Guides: Practical examples and solutions for common tasks, including capturing feed configs and AI agent workflows.
- Reference: Detailed information on configuration options, CLI commands, and the MCP server.