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
Copy file name to clipboardExpand all lines: src/content/docs/creating-custom-feeds.mdx
+29-1Lines changed: 29 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,12 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
19
19
releases](/web-application/reference/versioning-and-releases/) for details.
20
20
</Aside>
21
21
22
+
<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.
26
+
</Aside>
27
+
22
28
---
23
29
24
30
## When to Use Custom Configs
@@ -35,6 +41,20 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
35
41
36
42
---
37
43
44
+
## Recommended Workflow
45
+
46
+
1.**Inspect the live page** in your browser developer tools
47
+
2.**Write the smallest useful config** that extracts items, titles, and links
48
+
3.**Validate the config** with `html2rss validate your-config.yml`
49
+
4.**Render the feed** with `html2rss feed your-config.yml`
50
+
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
52
+
53
+
This order keeps iteration fast and makes it easier to see whether the problem is the page structure, your
54
+
selectors, or the fetch strategy.
55
+
56
+
---
57
+
38
58
## How It Works
39
59
40
60
A config file is a simple "recipe" that tells html2rss:
@@ -82,7 +102,7 @@ This says: "Find each article, get the title from the h2 anchor, and get the lin
82
102
83
103
## Your First Config
84
104
85
-
**Step 1:** Look at the website you want to create a feed for. Right-click → "View Page Source" to see the HTML structure.
105
+
**Step 1:** Inspect the website you want to create a feed for. Start with your browser's developer tools to inspect the live DOM. "View Page Source" can still help, but it may miss JavaScript-rendered content.
86
106
87
107
**Step 2:** Create a file called `example.com.yml` with this basic structure:
88
108
@@ -140,6 +160,12 @@ html2rss supports many configuration options:
140
160
141
161
4. **Check the output:** Make sure all items have titles, links, and descriptions
142
162
163
+
## Add It To html2rss-web
164
+
165
+
Once the config works locally, add it to your `feeds.yml` or shared config repository and restart your
166
+
instance. Then open the feed through your normal `html2rss-web` URL and confirm it behaves the same way
167
+
there.
168
+
143
169
---
144
170
145
171
## Sharing Your Config
@@ -177,11 +203,13 @@ html2rss supports many configuration options:
177
203
**For Beginners:**
178
204
179
205
- **[Browse the Feed Directory](/feed-directory/)** - See real-world examples
206
+
- **[Run html2rss-web with Docker](/web-application/getting-started)** - Use the newest integrated behavior
180
207
- **[Learn more about selectors](/ruby-gem/reference/selectors/)** - Master CSS selectors
181
208
- **[Submit your config via GitHub Web](https://github.com/html2rss/html2rss-configs)** - No Git knowledge required!
182
209
183
210
**For Contributors:**
184
211
185
212
- **[Browse existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs)** - See real examples
186
213
- **[Join discussions](https://github.com/orgs/html2rss/discussions)** - Connect with other users
214
+
- **[Learn about strategies](/ruby-gem/reference/strategy/)** - Decide when to use `browserless`
187
215
- **[Learn advanced features](/ruby-gem/how-to/advanced-features/)** - Take your configs to the next level
Ready to get RSS feeds from any website? Run `html2rss-web` locally with Docker, verify the interface, then start with included feeds before you move on to custom configs.
11
11
12
-
### Option 1: Use a Public Instance (Easiest)
12
+
##What Success Looks Like
13
13
14
-
**Try html2rss right now:**
14
+
After this guide, you should have:
15
15
16
-
1.**Go to a public html2rss instance** (see our [community wiki](https://github.com/html2rss/html2rss-web/wiki/Instances) for available instances)
17
-
2.**Browse existing feeds** or create auto-sourced feeds from any URL
18
-
3.**Copy the RSS URL** and add it to your feed reader
19
-
4.**Done!** You're now following the website in your RSS reader
16
+
-`html2rss-web` running at `http://localhost:3000`
17
+
- a list of working included feeds
18
+
- a clear next step for either auto-generation or custom configs
20
19
21
-
**Perfect for:** Testing, quick feeds, or if you don't want to install anything.
20
+
## Recommended Path
22
21
23
-
### Option 2: Install Your Own Instance
24
-
25
-
**For full control and custom feeds:**
26
-
27
-
1.**Follow the installation steps below**
28
-
2.**Create auto-sourced feeds** from any website
29
-
3.**Add custom configs** when you need more control
30
-
4.**Run your own RSS feed server** with stable HTTPS URLs
31
-
32
-
**Perfect for:** Power users, custom configurations, or when you need reliability.
33
-
34
-
---
35
-
36
-
## Installation Guide
37
-
38
-
This guide will help you set up your own copy of html2rss-web on your computer. Don't worry - we'll walk you through every step!
22
+
This guide will help you set up your own copy of `html2rss-web` on your computer. Start here if you want the most reliable path and the newest integrated behavior.
39
23
40
24
### What You'll Need
41
25
@@ -55,14 +39,9 @@ mkdir html2rss-web
55
39
cd html2rss-web
56
40
```
57
41
58
-
### Step 2: Create the Configuration File
59
-
60
-
Create a file called `docker-compose.yml` in your new folder. This file tells Docker how to set up html2rss-web with all the features you need.
61
-
62
-
**How to create the file:**
42
+
### Step 2: Create a Minimal Configuration File
63
43
64
-
-**Using a text editor:** Create a new file and save it as `docker-compose.yml`
65
-
-**Using terminal:** Use any text editor to create the file
44
+
Create a file called `docker-compose.yml` in your new folder. Start with the minimal local stack:
**Need more control?** You can add custom feed configurations to your `feeds.yml` file. See our [Creating Custom Feeds](/creating-custom-feeds) guide for details.
132
+
-**Use included configs** when the site already exists in the directory
133
+
-**Enable automatic feed generation** when you want to try a site quickly without writing YAML
134
+
-**Write a custom config** when auto-generation is incomplete or you need precise control
162
135
163
136
---
164
137
@@ -175,11 +148,7 @@ Your html2rss-web instance comes with pre-configured feeds for popular websites.
175
148
176
149
## Next Steps
177
150
178
-
**Ready for more?**
179
-
180
-
-**[Browse the Feed Directory](/feed-directory/)** - See real-world examples
181
-
-**[Create Custom Feeds](/creating-custom-feeds)** - Learn to write your own configurations
182
-
-**[Troubleshooting Guide](/troubleshooting/troubleshooting)** - Solve common issues
183
-
-**[Join the Community](https://github.com/orgs/html2rss/discussions)** - Get help and share ideas
184
-
185
-
**🎉 Congratulations!** You now have your own RSS feed server running.
151
+
1.**[Use the included configs](/web-application/how-to/use-included-configs/)** - Start with working feeds
152
+
2.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)** - Enable the quick-generate flow
153
+
3.**[Create Custom Feeds](/creating-custom-feeds)** - Add and test your own YAML configs
154
+
4.**[Troubleshooting Guide](/troubleshooting/troubleshooting)** - Solve startup and extraction issues
Copy file name to clipboardExpand all lines: src/content/docs/index.mdx
+31-15Lines changed: 31 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,21 @@ title: "Turn Any Website Into an RSS Feed - Never Miss Updates Again"
3
3
description: "Create RSS feeds from any website - no coding required. Turn blogs, news sites, and forums into RSS feeds you can follow in your favorite reader. Free, open source, and easy to use."
4
4
---
5
5
6
-
Ever wished you could follow your favorite websites like a social media feed? The html2rss project makes it possible by creating RSS feeds for any website - even ones that don't offer them.
6
+
Run `html2rss-web` with Docker, start with included feeds, and add custom configs only when you need more control.
7
7
8
8
## 🚀 Get Started in 30 Seconds
9
9
10
-
**Try it now:**[Browse Ready-Made Feeds](/feed-directory/) | [Get Started](/getting-started)
10
+
**Start here:**[Run html2rss-web with Docker](/web-application/getting-started) | [Browse working feed examples](/feed-directory/)
11
+
12
+
Need more control? [Write a custom feed config](/creating-custom-feeds)
13
+
14
+
---
15
+
16
+
## How It Works
17
+
18
+
1.**Run your own local instance** with Docker
19
+
2.**Use included feeds or add your own** website targets
20
+
3.**Subscribe from your RSS reader** using stable feed URLs
11
21
12
22
---
13
23
@@ -34,30 +44,30 @@ Ever wished you could follow your favorite websites like a social media feed? Th
34
44
35
45
## What is html2rss?
36
46
37
-
html2rss is a user-friendly tool that turns any website into an RSS feed. Think of it as a translator that converts website content into a format your feed reader can understand.
47
+
html2rss is a toolkit for turning websites into RSS feeds. Think of it as a translator that converts website content into a format your feed reader can understand.
38
48
39
-
**Two ways to use html2rss:**
49
+
**Most people should start with the web application:**
40
50
41
-
-**🌐 Web App** - RSS feed server with auto-sourcing. Perfect for everyone
42
-
-**⚙️ Ruby Gem** - The core engine that powers everything
51
+
-**🌐 html2rss-web** - The easiest way to run your own feed server with Docker
52
+
-**⚙️ html2rss gem** - The underlying engine, CLI, and developer interface
43
53
44
54
---
45
55
46
56
## 🎯 Choose Your Path
47
57
48
-
### I'm Getting Started with RSS
58
+
### I want a working instance first
49
59
50
-
1.**[Get Started](/getting-started)** - Complete guide to using html2rss
51
-
2.**[Browse Examples](/feed-directory/)** - See 100+ ready-made feeds
52
-
3.**[Learn More](/about/)** - Understand how it all works
60
+
1.**[Run html2rss-web with Docker](/web-application/getting-started)** - Recommended starting path
61
+
2.**[Browse working feed examples](/feed-directory/)** - See what success looks like
62
+
3.**[Use the included configs](/web-application/how-to/use-included-configs/)** - Start with ready-made feeds
53
63
54
-
### I Want to Create Custom Feeds
64
+
### I need more control
55
65
56
-
1.**[Creating Custom Feeds](/creating-custom-feeds)** - Learn to write your own configs
57
-
2.**[Ruby Gem Reference](/ruby-gem/)** - Full technical documentation
58
-
3.**[Share Your Configs](/get-involved/contributing/)** - Help the community
66
+
1.**[Creating Custom Feeds](/creating-custom-feeds)** - Write and test your own configs
67
+
2.**[Selectors Reference](/ruby-gem/reference/selectors/)** - Learn the matching rules
68
+
3.**[Strategy Reference](/ruby-gem/reference/strategy/)** - Use `browserless` for JS-heavy sites
59
69
60
-
### I'm a Developer
70
+
### I'm building or integrating
61
71
62
72
1.**[Ruby Gem Reference](/ruby-gem/)** - Full API documentation
63
73
2.**[Advanced Features](/ruby-gem/how-to/advanced-features/)** - Custom HTTP requests, etc.
@@ -80,6 +90,12 @@ html2rss is a user-friendly tool that turns any website into an RSS feed. Think
80
90
81
91
## 🔧 Common Issues?
82
92
93
+
**Start with Docker, not a public instance.** That gives you the most reliable path and the newest integrated behavior.
94
+
83
95
**Feed not working?** Check our [troubleshooting guide](/troubleshooting/troubleshooting)
96
+
97
+
**Need custom control?** Continue to [Creating Custom Feeds](/creating-custom-feeds)
0 commit comments