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
16
+
latest released `html2rss` gem. If you want the newest integrated behavior, prefer running
17
+
[`html2rss-web`](/web-application/getting-started) via Docker. The web application ships as a rolling
18
+
release and usually reflects the latest development state of the gem first. See [Versioning and
19
+
releases](/web-application/reference/versioning-and-releases/) for details.
20
+
</Aside>
21
+
12
22
---
13
23
14
24
## When to Use Custom Configs
@@ -114,15 +124,21 @@ html2rss supports many configuration options:
114
124
115
125
**Before sharing your config, test it:**
116
126
117
-
1. **Test with Ruby gem:**
127
+
1. **Validate the config first:**
128
+
129
+
```bash
130
+
html2rss validate your-config.yml
131
+
```
132
+
133
+
2. **Then render the feed with the Ruby gem:**
118
134
119
135
```bash
120
136
html2rss feed your-config.yml
121
137
```
122
138
123
-
2. **Test with web app:** Add your config to the `feeds.yml` file and restart your instance
139
+
3. **Test with `html2rss-web`:** Add your config to the `feeds.yml` file and restart your instance
124
140
125
-
3. **Check the output:** Make sure all items have titles, links, and descriptions
141
+
4. **Check the output:** Make sure all items have titles, links, and descriptions
0 commit comments