Skip to content

Commit 3dd4e5e

Browse files
authored
fix(docs): repair custom feed guide navigation (#1087)
* fix(docs): repair custom feed guide navigation * Update src/content/docs/creating-custom-feeds.mdx
1 parent f56abcc commit 3dd4e5e

2 files changed

Lines changed: 21 additions & 5 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: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,20 @@ 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
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+
1222
---
1323

1424
## When to Use Custom Configs
@@ -114,15 +124,21 @@ html2rss supports many configuration options:
114124

115125
**Before sharing your config, test it:**
116126

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

119135
```bash
120136
html2rss feed your-config.yml
121137
```
122138

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
124140

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
126142

127143
---
128144

0 commit comments

Comments
 (0)