You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "See how people use html2rss to stay updated with their favorite websites. Real examples for personal and business use cases."
3
+
description: "Use html2rss for common tracking and monitoring workflows."
4
4
---
5
5
6
-
Discover how people are using html2rss to take control of their web content consumption. These real-world examples show the power and flexibility of creating custom RSS feeds.
7
-
8
-
---
6
+
Use html2rss when you want updates in a reader instead of checking websites by hand.
9
7
10
8
## Personal Use Cases
11
9
12
10
### Following Your Favorite Bloggers
13
11
14
-
Many bloggers don't offer RSS feeds, but you can create them with html2rss. Follow writers you love without relying on social media algorithms.
12
+
Many blogs and creator sites do not publish feeds.
15
13
16
-
**Example:**Create a feed for a personal blog that only posts to social media.
14
+
**Example:**Follow a newsroom, company blog, or publication section from your own `html2rss-web` deployment.
17
15
18
16
### Job Hunting
19
17
20
18
Track job postings from multiple company websites in one place. Never miss an opportunity again.
21
19
22
-
**Example:**Follow job boards, company career pages, and industry-specific job sites.
20
+
**Example:**Track a company careers page or a narrower role-specific listing.
23
21
24
22
### Local News
25
23
26
24
Follow your local newspaper or community website to stay informed about your neighborhood.
27
25
28
-
**Example:**Create feeds for local news sites, community forums, and city government updates.
26
+
**Example:**Subscribe to local news sites, community forums, and city government updates from one reader.
29
27
30
28
### Academic Research
31
29
32
30
Follow new papers and research in your field from multiple sources.
33
31
34
-
**Example:** Track arXiv submissions, journal publications, and conference proceedings.
32
+
**Example:** Track publication pages, research blogs, and conference updates.
35
33
36
34
### Product Updates
37
35
38
36
Get notified when software you use releases updates, new features, or security patches.
39
37
40
-
**Example:**Follow product blogs, changelog pages, and release notes.
38
+
**Example:**Track release notes, changelog pages, and product blogs.
41
39
42
40
### Hobby Communities
43
41
44
42
Follow forums, communities, and websites related to your hobbies and interests.
45
43
46
-
**Example:** Track gaming forums, photography communities, or cooking blogs.
47
-
48
-
---
44
+
**Example:** Track gaming forums, photography communities, or cooking blogs without manually checking each site.
49
45
50
46
## Business Use Cases
51
47
@@ -59,21 +55,19 @@ Track what your competitors are posting about - new products, features, or annou
59
55
60
56
Follow multiple industry publications in one feed to stay ahead of trends.
61
57
62
-
**Example:** Aggregate news from industry blogs, trade publications, and thought leaders.
58
+
**Example:** Aggregate trade publications, company blogs, and research updates in one reader.
63
59
64
60
### Customer Support
65
61
66
62
Monitor customer feedback and support requests across different platforms.
67
63
68
-
**Example:** Track support forums, review sites, and social media mentions.
64
+
**Example:** Track support forums, review sites, and product-update pages that affect your users.
69
65
70
66
### Content Marketing
71
67
72
68
Follow industry influencers and competitors for content inspiration.
73
69
74
-
**Example:** Track competitor blogs, industry newsletters, and thought leadership content.
75
-
76
-
---
70
+
**Example:** Track competitor blogs, industry newsletters, and thought leadership content in one place.
77
71
78
72
## Technical Use Cases
79
73
@@ -95,20 +89,8 @@ Follow multiple open source projects and their updates.
95
89
96
90
**Example:** Track project blogs, release notes, and community discussions.
97
91
98
-
---
99
-
100
-
## Getting Started with Your Use Case
101
-
102
-
1.**Identify the websites** you want to follow
103
-
2.**Check our [Feed Directory](/feed-directory/)** to see if feeds already exist
104
-
3.**Try the [Web App](/web-application/getting-started)** to create feeds easily
105
-
4.**Learn advanced techniques** with our [Config Guide](/creating-custom-feeds/)
106
-
107
-
---
108
-
109
-
## Need Help?
92
+
## Next Steps
110
93
111
-
-**Can't find what you're looking for?**[Browse our Feed Directory](/feed-directory/)
112
-
-**Want to create custom feeds?**[Try the Web App](/web-application/getting-started)
When auto-sourcing isn't enough, you can write your own configuration files to create custom RSS feeds for any website. This guide shows you how to take full control with YAML configs.
10
+
When existing feeds or auto-sourcing are not enough, write a YAML config for the site you want to follow.
11
11
12
12
**Prerequisites:** You should be familiar with the [Getting Started](/getting-started) guide before diving into custom configurations.
13
13
14
-
<Asidetype="note"title="Release note">
15
-
This guide tracks the current documentation tree and may describe features that have not yet shipped in the
16
-
latest released `html2rss` gem. If you want the newest integrated behavior, prefer running
17
-
[`html2rss-web`](/web-application/getting-started) via Docker. The web application ships as a rolling
18
-
release and usually reflects the latest development state of the gem first. See [Versioning and
19
-
releases](/web-application/reference/versioning-and-releases/) for details.
20
-
</Aside>
21
-
22
14
<Asidetype="tip"title="Use this guide when you need more control">
23
-
Start with included feeds first. If your site is not covered, try [automatic feed
24
-
generation](/web-application/how-to/use-automatic-feed-generation/) next. Reach for a custom config when you
25
-
need a stable, reviewable setup or the generated feed misses important content.
15
+
Reach for a custom config when you need stable, reviewable extraction rules or generated output misses
16
+
important content.
26
17
</Aside>
27
18
28
19
---
@@ -37,18 +28,14 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
37
28
-**The website has complex structure** that requires custom selectors
38
29
-**You want to combine data** from multiple sources
39
30
40
-
**Don't need custom configs?** Check the [Feed Directory](/feed-directory/) first - there might already be a working feed for your website.
41
-
42
-
---
43
-
44
31
## Recommended Workflow
45
32
46
33
1.**Inspect the live page** in your browser developer tools
47
34
2.**Write the smallest useful config** that extracts items, titles, and links
48
35
3.**Validate the config** with `html2rss validate your-config.yml`
49
36
4.**Render the feed** with `html2rss feed your-config.yml`
50
37
5.**Add it to `html2rss-web`** so you can use it through your normal instance
51
-
6.**Escalate to `browserless`** if the content is rendered by JavaScript
38
+
6.**Escalate request strategy when needed**: use a browser-based rendering strategy only when troubleshooting requires it
52
39
53
40
This order keeps iteration fast and makes it easier to see whether the problem is the page structure, your
54
41
selectors, or the fetch strategy.
@@ -210,7 +197,7 @@ there.
210
197
-**No items found?** Check your selectors with browser tools (F12) - the `items.selector` might not match the page structure
211
198
-**Invalid YAML?** Use spaces, not tabs, and ensure proper indentation
212
199
-**Website not loading?** Check the URL and try accessing it in your browser
213
-
-**Missing content?**Some websites load content with JavaScript - you may need to use the `browserless` strategy
200
+
-**Missing content?**Try a browser-based rendering strategy during troubleshooting
214
201
-**Wrong data extracted?** Verify your selectors are pointing to the right elements
215
202
216
203
**Need more help?** See our [comprehensive troubleshooting guide](/troubleshooting/troubleshooting) or ask in [GitHub Discussions](https://github.com/orgs/html2rss/discussions).
@@ -225,7 +212,6 @@ there.
225
212
226
213
**For Beginners:**
227
214
228
-
-**[Browse the Feed Directory](/feed-directory/)** - See real-world examples
229
215
-**[Run html2rss-web with Docker](/web-application/getting-started)** - Use the newest integrated behavior
230
216
-**[Learn more about selectors](/ruby-gem/reference/selectors/)** - Master CSS selectors
231
217
-**[Submit your config via GitHub Web](https://github.com/html2rss/html2rss-configs)** - No Git knowledge required!
@@ -234,5 +220,5 @@ there.
234
220
235
221
-**[Browse existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs)** - See real examples
236
222
-**[Join discussions](https://github.com/orgs/html2rss/discussions)** - Connect with other users
237
-
-**[Learn about strategies](/ruby-gem/reference/strategy/)** - Decide when to use `browserless`
223
+
-**[Learn about strategies](/ruby-gem/reference/strategy/)** - Decide when to use static vs JavaScript/browser-based extraction
238
224
-**[Learn advanced features](/ruby-gem/how-to/advanced-features/)** - Take your configs to the next level
Copy file name to clipboardExpand all lines: src/content/docs/getting-started.mdx
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "Getting Started"
3
-
description: "Start html2rss-web locally, verify a working included feed from your self-hosted instance, and decide when to enable automatic generation or move to custom configs."
3
+
description: "Start html2rss-web locally, verify one feed, and decide when to enable automatic generation or move to custom configs."
4
4
sidebar:
5
5
order: 1
6
6
---
@@ -17,13 +17,12 @@ That guide is the canonical setup flow for:
17
17
18
18
- running `html2rss-web` locally
19
19
- confirming the interface is working
20
-
- opening a first included feed URL
20
+
- opening a known feed URL
21
21
- deciding when to use automatic generation or custom configs
22
22
23
23
## Quick Shortcuts
24
24
25
25
-**[Run html2rss-web with Docker](/web-application/getting-started)**: recommended first step
26
-
-**[Browse working feed examples](/feed-directory/)**: see what successful outputs look like
27
26
-**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct feed creation from a page URL when you want that workflow
28
27
-**[Create Custom Feeds](/creating-custom-feeds)**: write configs when you need more control
29
28
-**[Troubleshooting Guide](/troubleshooting/troubleshooting)**: fix startup or extraction problems
@@ -34,6 +33,8 @@ If you are working directly with the gem instead of `html2rss-web`, start with:
34
33
35
34
<Codecode={`html2rss auto https://example.com/blog`}lang="bash" />
36
35
36
+
For strategy behavior and manual overrides, see the [Strategy reference](/ruby-gem/reference/strategy).
37
+
37
38
If the target site is unusually redirect-heavy or needs extra follow-up requests, the CLI also supports:
38
39
39
40
<Codecode={`html2rss auto https://example.com/blog --max-redirects 10 --max-requests 5`}lang="bash" />
Copy file name to clipboardExpand all lines: src/content/docs/index.mdx
+7-14Lines changed: 7 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
---
2
2
title: "Turn Any Website Into an RSS Feed"
3
-
description: "Run html2rss-web with Docker, verify a working included feed from your self-hosted instance, then consciously enable automatic generation or move to custom configs when you need more control."
3
+
description: "Run html2rss-web with Docker, verify one feed, then enable automatic generation or move to custom configs when you need more control."
4
4
---
5
5
6
-
Run `html2rss-web` with Docker, verify a working included feed from your self-hosted instance, and only then decide whether to enable automatic generation or move to custom configs.
6
+
Run `html2rss-web` with Docker, verify one feed from your own instance, then decide whether you need automatic generation or custom configs.
7
7
8
8
## Start Here
9
9
@@ -13,14 +13,8 @@ That guide is the canonical onboarding flow for:
13
13
14
14
- starting a local instance
15
15
- verifying the web interface
16
-
- opening a first included feed URL
17
-
- deciding when to consciously enable automatic generation or move to custom configs
18
-
19
-
## How It Works
20
-
21
-
1.**Run your own local instance** with Docker
22
-
2.**Open a built-in feed URL** from your own instance
23
-
3.**Copy the feed URL into your reader**
16
+
- opening a known feed URL
17
+
- choosing the next path
24
18
25
19
## What is html2rss?
26
20
@@ -36,14 +30,13 @@ Most people should start with the web application:
36
30
### I want a working instance first
37
31
38
32
1.**[Run html2rss-web with Docker](/web-application/getting-started)**: recommended starting path
39
-
2.**[Use the included configs](/web-application/how-to/use-included-configs/)**: use real embedded feeds from your own instance
40
-
3.**[Browse working feed examples](/feed-directory/)**: see what working outputs look like
33
+
2.**[Use the included configs](/web-application/how-to/use-included-configs/)**: optional guide for the embedded feed set
41
34
42
35
### I need more control
43
36
44
37
1.**[Creating Custom Feeds](/creating-custom-feeds)**: write and test your own configs
45
38
2.**[Selectors Reference](/ruby-gem/reference/selectors/)**: learn the matching rules
46
-
3.**[Strategy Reference](/ruby-gem/reference/strategy/)**: decide when `browserless` is justified
39
+
3.**[Strategy Reference](/ruby-gem/reference/strategy/)**: choose the right extraction strategy for static vs JavaScript-heavy pages
47
40
48
41
### I'm building or integrating
49
42
@@ -62,7 +55,7 @@ Most people should start with the web application:
62
55
## Practical Notes
63
56
64
57
- Start with Docker, not a public instance.
65
-
-Use an included feed to verify the deployment first.
58
+
-Verify the deployment with one known feed first.
66
59
- Enable automatic generation only when you want the direct page-URL workflow and are ready to allow it on your self-hosted instance.
67
60
- Move to custom configs when you need a stable, reviewable setup.
Copy file name to clipboardExpand all lines: src/content/docs/ruby-gem/how-to/advanced-features.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ html2rss uses parallel processing in auto-source discovery. This happens automat
16
16
1.**Use appropriate selectors:** More specific selectors reduce processing time
17
17
2.**Limit items when possible:** Use CSS selectors that target only the content you need
18
18
3.**Cache responses:** The web application caches responses automatically
19
-
4.**Choose the right strategy:** Use `faraday`for static content, `browserless` only when JavaScript is required
19
+
4.**Choose the right strategy:** Use static HTTP fetching for simple pages, and move to a JavaScript/browser-based extraction strategy when rendering or anti-bot handling is required
0 commit comments