This repository hosts the documentation and website for html2rss, a tool for creating RSS feeds from any
website.
- Node.js (for Astro)
# Install dependencies make setup # Start the local Astro development server make dev
Feed Directory browse data comes from a running html2rss-web instance (GET /api/v1/configs). For local feed-directory testing, run an instance (for example from html2rss-web) and point the directory UI at it.
You can develop html2rss directly in your browser using GitHub Codespaces:
The Codespace provides a cloud development environment with Node.js pre-installed. Run make setup to install dependencies and get started!
make setup- Install npm dependenciesmake dev- Start Astro development servermake build- Build for productionmake preview- Preview production buildmake lintfix- Fix code formatting
| 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
Contributions are welcome! See our Get Involved page for details on discussions, reporting issues, and contributing.