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
14
<Asidetype="tip"title="Use this guide when you need more control">
15
-
Start with included feeds first. If your site is not covered, try [automatic feed
16
-
generation](/web-application/how-to/use-automatic-feed-generation/) next. Reach for a custom config when you
17
-
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.
18
17
</Aside>
19
18
20
19
---
@@ -29,10 +28,6 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
29
28
-**The website has complex structure** that requires custom selectors
30
29
-**You want to combine data** from multiple sources
31
30
32
-
**Don't need custom configs?** Check the [Feed Directory](/feed-directory/) first - there might already be a working feed for your website.
33
-
34
-
---
35
-
36
31
## Recommended Workflow
37
32
38
33
1.**Inspect the live page** in your browser developer tools
@@ -217,7 +212,6 @@ there.
217
212
218
213
**For Beginners:**
219
214
220
-
-**[Browse the Feed Directory](/feed-directory/)** - See real-world examples
221
215
-**[Run html2rss-web with Docker](/web-application/getting-started)** - Use the newest integrated behavior
222
216
-**[Learn more about selectors](/ruby-gem/reference/selectors/)** - Master CSS selectors
223
217
-**[Submit your config via GitHub Web](https://github.com/html2rss/html2rss-configs)** - No Git knowledge required!
Copy file name to clipboardExpand all lines: src/content/docs/getting-started.mdx
+2-3Lines changed: 2 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
Copy file name to clipboardExpand all lines: src/content/docs/index.mdx
+6-13Lines changed: 6 additions & 13 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,8 +30,7 @@ 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
@@ -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.
Run `html2rss-web` locally with Docker, open the web interface, and verify that your instance can serve a working included feed before you enable direct feed generation.
13
+
Run `html2rss-web` locally with Dockerand verify one included feed before enabling direct feed generation.
14
14
15
15
## What You Will Have When This Works
16
16
@@ -23,7 +23,7 @@ After this guide, you should have:
23
23
24
24
## Installation Guide
25
25
26
-
This guide walks you through a local Docker setup that gives you the most reliable starting point.
26
+
This guide uses a local Docker Compose stack.
27
27
28
28
### What You'll Need
29
29
@@ -50,7 +50,7 @@ Create a file called `docker-compose.yml` in that folder and start with the mini
50
50
51
51
<MinimalDockerCompose />
52
52
53
-
This minimal stack intentionally proves the included-feed path first. Add automatic updates, reverse proxying, or your own config file only after this first run works.
53
+
Add automatic updates, reverse proxying, or your own config file after this first run works.
54
54
55
55
### Step 3: Start html2rss-web
56
56
@@ -73,28 +73,16 @@ Then run:
73
73
74
74
## First Success Check
75
75
76
-
At this point, `html2rss-web` should be running.
77
-
78
76
1. Open `http://localhost:4000`
79
77
2. Confirm the web interface loads
80
78
3. Open one of the included feed URLs from your own instance:
Copy file name to clipboardExpand all lines: src/content/docs/web-application/index.mdx
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,19 @@
1
1
---
2
2
title: "Web Application"
3
-
description: "html2rss-web is the self-hosted web interface and feed server for running included feeds first, then enabling direct generation only when needed."
3
+
description: "html2rss-web is the self-hosted web interface and feed server for included feeds, direct generation, and custom configs."
4
4
sidebar:
5
5
label: "Overview"
6
6
order: 1
7
7
---
8
8
9
-
`html2rss-web` is the recommended way to get started. Run it locally with Docker, verify a working included feed from your own instance, and only then decide whether you need token-gated direct generation or custom configs.
9
+
`html2rss-web` is the recommended way to get started. Run it locally with Docker, verify one feed from your own instance, then decide whether you need token-gated direct generation or custom configs.
10
10
11
11
## Get Started
12
12
13
13
Start with **[Getting Started](/web-application/getting-started)** to:
14
14
15
15
- run your own local instance
16
16
- verify the web interface
17
-
- open a first included feed URL
18
17
- choose the right next step for your site
19
18
20
19
## What The Web App Gives You
@@ -31,10 +30,9 @@ The scraping and feed-building engine is provided by the Ruby gem [`html2rss`](h
31
30
## Recommended Flow
32
31
33
32
1.**[Getting Started](/web-application/getting-started)**: run the app locally
34
-
2.**[Use the included configs](/web-application/how-to/use-included-configs/)**: start with embedded feed paths from your own instance
35
-
3.**[Browse working feed examples](/feed-directory/)**: compare against existing outputs
36
-
4.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct page-URL conversion when you want that workflow
37
-
5.**[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
33
+
2.**[Use the included configs](/web-application/how-to/use-included-configs/)**: use the embedded feed set when it covers your site
34
+
3.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct page-URL conversion when you want that workflow
35
+
4.**[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
0 commit comments