From 4672c00fa5a5323013032bcdc6504119a3c1b66d Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Thu, 12 Mar 2026 16:54:52 +0100 Subject: [PATCH 1/2] fix(docs): repair custom feed guide navigation --- astro.config.mjs | 4 ++-- src/content/docs/creating-custom-feeds.mdx | 21 +++++++++++++++++---- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/astro.config.mjs b/astro.config.mjs index 136d39fa..fb9174bf 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -11,7 +11,7 @@ export default defineConfig({ "/configs": "/feed-directory/", "/components/html2rss-web": "/web-application/", "/components/html2rss": "/ruby-gem/", - "/components/html2rss-configs": "/html2rss-configs/", + "/components/html2rss-configs": "/creating-custom-feeds/", "/components": "/", }, build: { @@ -301,7 +301,7 @@ export default defineConfig({ }, { label: "Write Your Own Feed Configs", - link: "/html2rss-configs", + link: "/creating-custom-feeds", }, { label: "About", diff --git a/src/content/docs/creating-custom-feeds.mdx b/src/content/docs/creating-custom-feeds.mdx index 62947b4b..9b38c89d 100644 --- a/src/content/docs/creating-custom-feeds.mdx +++ b/src/content/docs/creating-custom-feeds.mdx @@ -5,10 +5,17 @@ sidebar: order: 2 --- +import { Aside } from '@astrojs/starlight/components'; + 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. **Prerequisites:** You should be familiar with the [Getting Started](/getting-started) guide before diving into custom configurations. + + --- ## 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 ## Your First Config -**Step 1:** Look at the website you want to create a feed for. Right-click → "View Page Source" to see the HTML structure. +**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. **Step 2:** Create a file called `example.com.yml` with this basic structure: @@ -114,15 +121,21 @@ html2rss supports many configuration options: **Before sharing your config, test it:** -1. **Test with Ruby gem:** +1. **Validate the config first:** + + ```bash + html2rss validate your-config.yml + ``` + +2. **Then render the feed with the Ruby gem:** ```bash html2rss feed your-config.yml ``` -2. **Test with web app:** Add your config to the `feeds.yml` file and restart your instance +3. **Test with `html2rss-web`:** Add your config to the `feeds.yml` file and restart your instance -3. **Check the output:** Make sure all items have titles, links, and descriptions +4. **Check the output:** Make sure all items have titles, links, and descriptions --- From a3fe465d2f36ab933c8caf397a1bd53efa54f849 Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Thu, 12 Mar 2026 16:59:19 +0100 Subject: [PATCH 2/2] Update src/content/docs/creating-custom-feeds.mdx --- src/content/docs/creating-custom-feeds.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/content/docs/creating-custom-feeds.mdx b/src/content/docs/creating-custom-feeds.mdx index 9b38c89d..57d94b71 100644 --- a/src/content/docs/creating-custom-feeds.mdx +++ b/src/content/docs/creating-custom-feeds.mdx @@ -5,15 +5,18 @@ sidebar: order: 2 --- -import { Aside } from '@astrojs/starlight/components'; +import { Aside } from "@astrojs/starlight/components"; 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. **Prerequisites:** You should be familiar with the [Getting Started](/getting-started) guide before diving into custom configurations. --- @@ -79,7 +82,7 @@ This says: "Find each article, get the title from the h2 anchor, and get the lin ## Your First Config -**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. +**Step 1:** Look at the website you want to create a feed for. Right-click → "View Page Source" to see the HTML structure. **Step 2:** Create a file called `example.com.yml` with this basic structure: