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/index.mdx
+7-7Lines changed: 7 additions & 7 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, open the web interface, generate stable feed URLs, and move to custom configs only when you need more control."
3
+
description: "Run html2rss-web with Docker, open a working included feed from your own instance, and move to feature enablement or custom configs only when you need more control."
4
4
---
5
5
6
-
Run `html2rss-web` with Docker, open the web interface, and generate stable feed URLs from pages you want to follow.
6
+
Run `html2rss-web` with Docker, open a working included feed from your own instance, and move to direct generation or custom configs only when you need more control.
7
7
8
8
## Start Here
9
9
@@ -13,13 +13,13 @@ That guide is the canonical onboarding flow for:
13
13
14
14
- starting a local instance
15
15
- verifying the web interface
16
-
-generating a first feed URL
16
+
-opening a first included feed URL
17
17
- deciding when to use automatic generation or custom configs
18
18
19
19
## How It Works
20
20
21
21
1.**Run your own local instance** with Docker
22
-
2.**Open the web interface**and paste a page URL
22
+
2.**Open a built-in feed URL**from your own instance
23
23
3.**Copy the feed URL into your reader**
24
24
25
25
## What is html2rss?
@@ -36,7 +36,7 @@ Most people should start with the web application:
36
36
### I want a working instance first
37
37
38
38
1.**[Run html2rss-web with Docker](/web-application/getting-started)**: recommended starting path
39
-
2.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: create a feed directly from a page URL
39
+
2.**[Use the included configs](/web-application/how-to/use-included-configs/)**: use real embedded feeds from your own instance
40
40
3.**[Browse working feed examples](/feed-directory/)**: see what working outputs look like
41
41
42
42
### I need more control
@@ -62,8 +62,8 @@ Most people should start with the web application:
62
62
## Practical Notes
63
63
64
64
- Start with Docker, not a public instance.
65
-
- Use the web interface to verify the deployment first.
66
-
-Use automatic generation for the first pass.
65
+
- Use an included feed to verify the deployment first.
66
+
-Enable automatic generation only when you want the direct page-URL workflow.
67
67
- Move to custom configs when you need a stable, reviewable setup.
68
68
69
69
**Need help?** Continue to the [troubleshooting guide](/troubleshooting/troubleshooting) or join [GitHub Discussions](https://github.com/orgs/html2rss/discussions).
If that works, the deployment, interface, and feed-generation path are working together.
71
+
If that works, the deployment, static feed path, and reader subscription path are working together.
80
72
81
73
## What To Do First
82
74
83
-
Start with the web interface itself:
75
+
Start with an included config from your own instance:
84
76
85
-
1.create one feed from a known page URL
86
-
2.open or copy the generated feed URL
77
+
1.open a known included feed URL
78
+
2. copy that feed URL into your reader
87
79
3. confirm your reader can subscribe successfully
88
80
89
-
That proves the core path before you invest in deeper customization.
81
+
That proves the core path before you invest in custom configs or feature enablement.
90
82
91
83
<AutoGenerationOptional />
92
84
93
85
## Next Steps
94
86
95
-
1.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: understand the web UI creation path in more detail
96
-
2.**[Create Custom Feeds](/creating-custom-feeds)**: write your own configs when you need reviewable extraction rules
97
-
3.**[Browse working feed examples](/feed-directory/)**: compare outputs and existing configs
87
+
1.**[Use the included configs](/web-application/how-to/use-included-configs/)**: understand how built-in feed paths work
88
+
2.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct feed creation from page URLs when you want that workflow
89
+
3.**[Create Custom Feeds](/creating-custom-feeds)**: write your own configs when you need reviewable extraction rules
98
90
4.**[Need help?](/troubleshooting/troubleshooting)**: troubleshoot startup and extraction problems
description: "html2rss-web comes with hundreds of ready-made feeds for popular websites! No configuration needed - just use the URLs."
3
+
description: "Use the embedded html2rss-configs feed set from your own html2rss-web instance."
4
4
---
5
5
6
-
html2rss-web comes with hundreds of ready-made feeds for popular websites! No configuration needed - just use the URLs.
6
+
`html2rss-web` can serve the embedded `html2rss-configs` feed set directly from your own instance. This is the fastest path when you want a working feed without writing YAML first.
7
7
8
8
## How to Use Them
9
9
10
10
1.**Find a feed** in the [Feed Directory](/feed-directory/)
11
-
2.**Copy the URL** (it looks like `domainname.tld/whatever.rss`)
12
-
3.**Add it to your feed reader** - paste the URL and you're done!
11
+
2.**Set the Instance URL** to your own `html2rss-web` address
12
+
3.**Open the local feed path** from your instance
13
+
4.**Add it to your feed reader**
13
14
14
15
## What Success Looks Like
15
16
@@ -23,10 +24,10 @@ If that works, keep using included configs for that site. It is the lowest-maint
23
24
24
25
## Example
25
26
26
-
If you see a config file named `example.com/news.yml`, you can access it at:
27
-
`http://localhost:3000/example.com/news.rss`
27
+
If you see a config file named `phys.org/weekly.yml`, you can access it at:
28
+
`http://localhost:4000/phys.org/weekly.rss`
28
29
29
-
Just replace `localhost:3000` with your html2rss-web address.
30
+
Just replace `localhost:4000` with your own `html2rss-web` address.
30
31
31
32
## When to Move On
32
33
@@ -36,4 +37,7 @@ Use a custom config when:
36
37
- the included feed misses fields you care about
37
38
- you need a more specific page, section, or output format
38
39
39
-
Next step: [Create Custom Feeds](/creating-custom-feeds)
40
+
Next steps:
41
+
42
+
-[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/) when you want to create feeds directly from page URLs
43
+
-[Create Custom Feeds](/creating-custom-feeds) when you need a reviewable config
description: "html2rss-web is the self-hosted web interface for generating stable feed URLs from web pages."
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."
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, open the interface, generate a feed URL, and move to custom configs only when you need more control.
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 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
-
-generate a first feed URL
17
+
-open a first included feed URL
18
18
- choose the right next step for your site
19
19
20
20
## What The Web App Gives You
21
21
22
-
-**Stable feed URLs:**generated from your own deployment
23
-
-**Web interface:**paste a page URL and create a feed
22
+
-**Included feed catalog:**real embedded configs you can use immediately from your own deployment
23
+
-**Web interface:**direct feed creation when you explicitly enable it
24
24
-**Optional access control:** unlock custom generation with an access token when configured
25
25
-**Config-based extension path:** move to custom feeds when you need reviewable rules
26
26
-**Caching and HTTP handling:** shipped as part of the deployment
@@ -30,6 +30,7 @@ The scraping and feed-building engine is provided by the Ruby gem [`html2rss`](h
30
30
## Recommended Flow
31
31
32
32
1.**[Getting Started](/web-application/getting-started)**: run the app locally
33
-
2.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: create a feed from a page URL
33
+
2.**[Use the included configs](/web-application/how-to/use-included-configs/)**: start with embedded feed paths from your own instance
34
34
3.**[Browse working feed examples](/feed-directory/)**: compare against existing outputs
35
-
4.**[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
35
+
4.**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct page-URL conversion when you want that workflow
36
+
5.**[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
0 commit comments