html2rss is a Ruby gem that generates RSS 2.0 feeds from websites by scraping HTML or JSON content with CSS selectors or auto-detection.
This gem is the core of the html2rss-web application.
| Resource | Description | Link |
|---|---|---|
| 📚 Documentation & Feed Directory | Complete guides, tutorials, and browse 100+ pre-built feeds | html2rss.github.io |
| 💬 Community Discussions | Get help, share ideas, and connect with other users | GitHub Discussions |
| 📋 Project Board | Track development progress and upcoming features | View Project Board |
| 💖 Support Development | Help fund ongoing development and maintenance | Sponsor on GitHub |
Quick Start Options:
- New to RSS? → Start with the web application
- Ruby Developer? → Check out the Ruby gem documentation
- Need a specific feed? → Browse the feed directory
- Want to contribute? → See our contributing guide
- 🎯 CSS Selector Support - Extract content using familiar CSS selectors
- 🤖 Auto-Detection - Automatically detect content using Schema.org, JSON state, and semantic HTML
- 🔄 Multiple Request Strategies - Faraday for static sites, Browserless for JS-heavy sites
- 🛠️ Post-Processing - Template rendering, HTML sanitization, time parsing, and more
- 🧪 Comprehensive Testing - 95%+ test coverage with RSpec
- 📚 Full Documentation - YARD documentation and comprehensive guides
For installation and usage instructions, please visit the project website.
You can develop html2rss directly in your browser using GitHub Codespaces:
The Codespace comes pre-configured with Ruby 3.4 (compatible with Ruby 4.0), all dependencies, and VS Code extensions ready to go!
The full documentation for the html2rss gem is available on the project website.
Please see the contributing guide for details on how to contribute.
- Config - Loads and validates configuration (YAML/hash)
- RequestService - Fetches pages using Faraday or Browserless
- Selectors - Extracts content via CSS selectors with extractors/post-processors
- AutoSource - Auto-detects content using Schema.org, JSON state blobs, semantic HTML, and structural patterns
- RssBuilder - Assembles Article objects and renders RSS 2.0
Config -> Request -> Extraction -> Processing -> Building -> Output
- RSpec for comprehensive testing
- 95%+ code coverage with SimpleCov
- VCR for HTTP interaction testing
- RuboCop for code style enforcement
- Reek for code smell detection
- Ruby LSP for IntelliSense and language features
- Debug for modern debugging and exploration
- YARD for documentation generation
- GitHub Actions for CI/CD
This project is licensed under the MIT License - see the LICENSE file for details.
If you find html2rss useful, please consider sponsoring the project.