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/getting-started.mdx
+3-3Lines changed: 3 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 the web interface, generate your first feed URL, and decide when to move to custom configs."
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."
4
4
sidebar:
5
5
order: 1
6
6
---
@@ -17,14 +17,14 @@ That guide is the canonical setup flow for:
17
17
18
18
- running `html2rss-web` locally
19
19
- confirming the interface is working
20
-
-generating a first feed URL
20
+
-opening a first included 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
-
-**[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: create a feed directly from a page URL
27
26
-**[Browse working feed examples](/feed-directory/)**: see what successful outputs look like
27
+
-**[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
28
-**[Create Custom Feeds](/creating-custom-feeds)**: write configs when you need more control
29
29
-**[Troubleshooting Guide](/troubleshooting/troubleshooting)**: fix startup or extraction problems
Copy file name to clipboardExpand all lines: src/content/docs/index.mdx
+4-4Lines changed: 4 additions & 4 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 a working included feed from your own instance, and move to feature enablement or custom configs only when you need more control."
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."
4
4
---
5
5
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.
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.
7
7
8
8
## Start Here
9
9
@@ -14,7 +14,7 @@ That guide is the canonical onboarding flow for:
14
14
- starting a local instance
15
15
- verifying the web interface
16
16
- opening a first included feed URL
17
-
- deciding when to use automatic generation or custom configs
17
+
- deciding when to consciously enable automatic generation or move to custom configs
18
18
19
19
## How It Works
20
20
@@ -63,7 +63,7 @@ Most people should start with the web application:
63
63
64
64
- Start with Docker, not a public instance.
65
65
- Use an included feed to verify the deployment first.
66
-
- Enable automatic generation only when you want the direct page-URL workflow.
66
+
- Enable automatic generation only when you want the direct page-URL workflow and are ready to allow it on your self-hosted instance.
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).
Copy file name to clipboardExpand all lines: src/content/docs/ruby-gem/how-to/advanced-features.mdx
+2-10Lines changed: 2 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,7 @@ This guide covers advanced features and performance optimizations for html2rss.
7
7
8
8
## Parallel Processing
9
9
10
-
html2rss uses parallel processing in auto-source discovery to improve performance when multiple scrapers inspect the same page. This happens automatically and doesn't require any configuration.
11
-
12
-
### How It Works
13
-
14
-
-**Auto-source scraping:** Multiple scrapers run in parallel to analyze the same response body
15
-
-**Selectors and pagination:** Selector extraction and `rel="next"` pagination stay sequential and share the same request budget
16
-
-**Performance benefit:** Faster auto-discovery without changing selector semantics
10
+
html2rss uses parallel processing in auto-source discovery. This happens automatically and doesn't require any configuration.
17
11
18
12
### Performance Tips
19
13
@@ -75,8 +69,6 @@ selectors:
75
69
extractor: "href"
76
70
```
77
71
78
-
When you use the Browserless strategy, Chromium rejects transport-level headers such as `Host`, `Connection`, `Content-Length`, and `Transfer-Encoding`. html2rss filters those headers before navigation and logs the filtered header names at `info` level.
Copy file name to clipboardExpand all lines: src/content/docs/ruby-gem/reference/wordpress-api.mdx
+20-42Lines changed: 20 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,11 @@
1
1
---
2
2
title: "WordPress API"
3
-
description: "Use html2rss auto_source to read WordPress sites through their REST API instead of scraping article HTML."
3
+
description: "Use the WordPress API scraper inside auto_source to read WordPress posts through the site's REST API."
4
4
---
5
5
6
-
The `wordpress_api` scraper is part of `auto_source`. It detects WordPress sites that advertise a REST API in the page `<head>` and then fetches structured post data directly from that API.
6
+
The `wordpress_api` scraper is part of `auto_source`. When a WordPress site exposes its public REST API, `html2rss` can read posts from that API instead of scraping article HTML.
7
7
8
-
This is usually more reliable than HTML scraping because the response already contains fields such as title, content, excerpt, permalink, publish date, and category IDs.
This usually gives cleaner results because WordPress already exposes fields such as the title, content, excerpt, permalink, publish date, and category IDs.
23
9
24
10
## Basic Usage
25
11
@@ -31,11 +17,21 @@ channel:
31
17
auto_source: {}
32
18
```
33
19
34
-
If the target is a standard WordPress site with a public API, no selector configuration is required.
20
+
If the target is a standard WordPress site with a public API, no selectors are required.
21
+
22
+
## Requirements
23
+
24
+
The scraper works when the page exposes the standard WordPress API link in its `<head>`:
Copy file name to clipboardExpand all lines: src/content/docs/web-application/how-to/deployment.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
@@ -7,7 +7,7 @@ import DockerComposeSnippet from "../../../../components/docs/DockerComposeSnipp
7
7
8
8
html2rss-web ships on Docker Hub, so you can launch this self-hosted service wherever Docker runs. Start with the official [`docker-compose.yml`](https://github.com/html2rss/html2rss-web/blob/master/docker-compose.yml) from the [Installation Guide](/web-application/getting-started) as your baseline.
9
9
10
-
If you have not yet created a local instance, complete the [Getting Started guide](/web-application/getting-started) first. It walks through the one-time project directory setup, downloading the reference compose file, and confirming the application locally—steps we will build upon here.
10
+
If you have not yet created a local instance, complete the [Getting Started guide](/web-application/getting-started) first. It walks through the one-time project directory setup, creating a minimal compose file, and confirming the application locally, which gives you the right baseline before exposing a self-hosted instance publicly.
11
11
12
12
Already running html2rss-web on your workstation? Great! The sections below focus on what changes when you take that setup to production.
0 commit comments