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
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.
9
11
10
12
**Prerequisites:** You should be familiar with the [Getting Started](/getting-started) guide before diving into custom configurations.
11
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 latest released `html2rss` gem.
16
+
If you want the newest integrated behavior, prefer running [`html2rss-web`](/web-application/getting-started) via Docker. The web application ships as a rolling release and usually reflects the latest development state of the gem first. See [Versioning and releases](/web-application/reference/versioning-and-releases/) for details.
17
+
</Aside>
18
+
12
19
---
13
20
14
21
## When to Use Custom Configs
@@ -72,7 +79,7 @@ This says: "Find each article, get the title from the h2 anchor, and get the lin
72
79
73
80
## Your First Config
74
81
75
-
**Step 1:** Look at the website you want to create a feed for. Right-click → "View Page Source" to see the HTML structure.
82
+
**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.
76
83
77
84
**Step 2:** Create a file called `example.com.yml` with this basic structure:
78
85
@@ -114,15 +121,21 @@ html2rss supports many configuration options:
114
121
115
122
**Before sharing your config, test it:**
116
123
117
-
1. **Test with Ruby gem:**
124
+
1. **Validate the config first:**
125
+
126
+
```bash
127
+
html2rss validate your-config.yml
128
+
```
129
+
130
+
2. **Then render the feed with the Ruby gem:**
118
131
119
132
```bash
120
133
html2rss feed your-config.yml
121
134
```
122
135
123
-
2. **Test with web app:** Add your config to the `feeds.yml` file and restart your instance
136
+
3. **Test with `html2rss-web`:** Add your config to the `feeds.yml` file and restart your instance
124
137
125
-
3. **Check the output:** Make sure all items have titles, links, and descriptions
138
+
4. **Check the output:** Make sure all items have titles, links, and descriptions
0 commit comments