Skip to content

Commit 4672c00

Browse files
committed
fix(docs): repair custom feed guide navigation
1 parent f56abcc commit 4672c00

2 files changed

Lines changed: 19 additions & 6 deletions

File tree

astro.config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export default defineConfig({
1111
"/configs": "/feed-directory/",
1212
"/components/html2rss-web": "/web-application/",
1313
"/components/html2rss": "/ruby-gem/",
14-
"/components/html2rss-configs": "/html2rss-configs/",
14+
"/components/html2rss-configs": "/creating-custom-feeds/",
1515
"/components": "/",
1616
},
1717
build: {
@@ -301,7 +301,7 @@ export default defineConfig({
301301
},
302302
{
303303
label: "Write Your Own Feed Configs",
304-
link: "/html2rss-configs",
304+
link: "/creating-custom-feeds",
305305
},
306306
{
307307
label: "About",

src/content/docs/creating-custom-feeds.mdx

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@ sidebar:
55
order: 2
66
---
77

8+
import { Aside } from '@astrojs/starlight/components';
9+
810
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.
911

1012
**Prerequisites:** You should be familiar with the [Getting Started](/getting-started) guide before diving into custom configurations.
1113

14+
<Aside type="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+
1219
---
1320

1421
## 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
7279

7380
## Your First Config
7481

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.
7683

7784
**Step 2:** Create a file called `example.com.yml` with this basic structure:
7885

@@ -114,15 +121,21 @@ html2rss supports many configuration options:
114121

115122
**Before sharing your config, test it:**
116123

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:**
118131

119132
```bash
120133
html2rss feed your-config.yml
121134
```
122135

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
124137

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
126139

127140
---
128141

0 commit comments

Comments
 (0)