getting-started.mdx

title	Getting Started
description	Learn how to get RSS feeds from any website. Start with existing feeds or create your own in minutes.
sidebar	order 1

import Code from "astro/components/Code.astro";

This page points to the main onboarding flow.

Start Here

If you want the recommended path, go to Run html2rss-web with Docker.

That guide is the canonical setup flow for:

• running html2rss-web locally
• confirming your first successful feed
• deciding when to use included feeds, automatic generation, or custom configs

Quick Shortcuts

• Run html2rss-web with Docker - Recommended first step
• Browse working feed examples - See what success looks like
• Create Custom Feeds - Write configs when you need more control
• Troubleshooting Guide - Fix startup or extraction problems

Using the Ruby CLI

If you are working directly with the gem instead of html2rss-web, start with:

<Code code={html2rss auto https://example.com/blog} lang="bash" />

If the target site is unusually redirect-heavy or needs extra follow-up requests, the CLI also supports:

<Code code={html2rss auto https://example.com/blog --max-redirects 10 --max-requests 5} lang="bash" />

For config-driven runs, the same flags are available on html2rss feed.