Skip to content

Commit 4085637

Browse files
committed
docs(onboarding): make docker the default path
1 parent 3dd4e5e commit 4085637

4 files changed

Lines changed: 127 additions & 132 deletions

File tree

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

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
1919
releases](/web-application/reference/versioning-and-releases/) for details.
2020
</Aside>
2121

22+
<Aside type="tip" title="Use this guide when you need more control">
23+
Start with included feeds first. If your site is not covered, try [automatic feed
24+
generation](/web-application/how-to/use-automatic-feed-generation/) next. Reach for a custom config when you
25+
need a stable, reviewable setup or the generated feed misses important content.
26+
</Aside>
27+
2228
---
2329

2430
## When to Use Custom Configs
@@ -35,6 +41,20 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
3541

3642
---
3743

44+
## Recommended Workflow
45+
46+
1. **Inspect the live page** in your browser developer tools
47+
2. **Write the smallest useful config** that extracts items, titles, and links
48+
3. **Validate the config** with `html2rss validate your-config.yml`
49+
4. **Render the feed** with `html2rss feed your-config.yml`
50+
5. **Add it to `html2rss-web`** so you can use it through your normal instance
51+
6. **Escalate to `browserless`** if the content is rendered by JavaScript
52+
53+
This order keeps iteration fast and makes it easier to see whether the problem is the page structure, your
54+
selectors, or the fetch strategy.
55+
56+
---
57+
3858
## How It Works
3959

4060
A config file is a simple "recipe" that tells html2rss:
@@ -82,7 +102,7 @@ This says: "Find each article, get the title from the h2 anchor, and get the lin
82102

83103
## Your First Config
84104

85-
**Step 1:** Look at the website you want to create a feed for. Right-click → "View Page Source" to see the HTML structure.
105+
**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.
86106

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

@@ -140,6 +160,12 @@ html2rss supports many configuration options:
140160

141161
4. **Check the output:** Make sure all items have titles, links, and descriptions
142162

163+
## Add It To html2rss-web
164+
165+
Once the config works locally, add it to your `feeds.yml` or shared config repository and restart your
166+
instance. Then open the feed through your normal `html2rss-web` URL and confirm it behaves the same way
167+
there.
168+
143169
---
144170

145171
## Sharing Your Config
@@ -177,11 +203,13 @@ html2rss supports many configuration options:
177203
**For Beginners:**
178204

179205
- **[Browse the Feed Directory](/feed-directory/)** - See real-world examples
206+
- **[Run html2rss-web with Docker](/web-application/getting-started)** - Use the newest integrated behavior
180207
- **[Learn more about selectors](/ruby-gem/reference/selectors/)** - Master CSS selectors
181208
- **[Submit your config via GitHub Web](https://github.com/html2rss/html2rss-configs)** - No Git knowledge required!
182209

183210
**For Contributors:**
184211

185212
- **[Browse existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs)** - See real examples
186213
- **[Join discussions](https://github.com/orgs/html2rss/discussions)** - Connect with other users
214+
- **[Learn about strategies](/ruby-gem/reference/strategy/)** - Decide when to use `browserless`
187215
- **[Learn advanced features](/ruby-gem/how-to/advanced-features/)** - Take your configs to the next level

src/content/docs/getting-started.mdx

Lines changed: 35 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,21 @@ sidebar:
55
order: 1
66
---
77

8-
Ready to get RSS feeds from any website? Choose your path below. No technical knowledge required!
8+
import { Aside } from "@astrojs/starlight/components";
99

10-
## Quick Start Options
10+
Ready to get RSS feeds from any website? Run `html2rss-web` locally with Docker, verify the interface, then start with included feeds before you move on to custom configs.
1111

12-
### Option 1: Use a Public Instance (Easiest)
12+
## What Success Looks Like
1313

14-
**Try html2rss right now:**
14+
After this guide, you should have:
1515

16-
1. **Go to a public html2rss instance** (see our [community wiki](https://github.com/html2rss/html2rss-web/wiki/Instances) for available instances)
17-
2. **Browse existing feeds** or create auto-sourced feeds from any URL
18-
3. **Copy the RSS URL** and add it to your feed reader
19-
4. **Done!** You're now following the website in your RSS reader
16+
- `html2rss-web` running at `http://localhost:3000`
17+
- a list of working included feeds
18+
- a clear next step for either auto-generation or custom configs
2019

21-
**Perfect for:** Testing, quick feeds, or if you don't want to install anything.
20+
## Recommended Path
2221

23-
### Option 2: Install Your Own Instance
24-
25-
**For full control and custom feeds:**
26-
27-
1. **Follow the installation steps below**
28-
2. **Create auto-sourced feeds** from any website
29-
3. **Add custom configs** when you need more control
30-
4. **Run your own RSS feed server** with stable HTTPS URLs
31-
32-
**Perfect for:** Power users, custom configurations, or when you need reliability.
33-
34-
---
35-
36-
## Installation Guide
37-
38-
This guide will help you set up your own copy of html2rss-web on your computer. Don't worry - we'll walk you through every step!
22+
This guide will help you set up your own copy of `html2rss-web` on your computer. Start here if you want the most reliable path and the newest integrated behavior.
3923

4024
### What You'll Need
4125

@@ -55,14 +39,9 @@ mkdir html2rss-web
5539
cd html2rss-web
5640
```
5741

58-
### Step 2: Create the Configuration File
59-
60-
Create a file called `docker-compose.yml` in your new folder. This file tells Docker how to set up html2rss-web with all the features you need.
61-
62-
**How to create the file:**
42+
### Step 2: Create a Minimal Configuration File
6343

64-
- **Using a text editor:** Create a new file and save it as `docker-compose.yml`
65-
- **Using terminal:** Use any text editor to create the file
44+
Create a file called `docker-compose.yml` in your new folder. Start with the minimal local stack:
6645

6746
```yaml
6847
services:
@@ -83,14 +62,6 @@ services:
8362
BROWSERLESS_IO_WEBSOCKET_URL: ws://browserless:3001
8463
BROWSERLESS_IO_API_TOKEN: 6R0W53R135510
8564

86-
watchtower:
87-
image: containrrr/watchtower
88-
restart: unless-stopped
89-
volumes:
90-
- /var/run/docker.sock:/var/run/docker.sock
91-
- "~/.docker/config.json:/config.json"
92-
command: --cleanup --interval 7200
93-
9465
browserless:
9566
image: "ghcr.io/browserless/chromium"
9667
restart: unless-stopped
@@ -102,6 +73,8 @@ services:
10273
TOKEN: 6R0W53R135510
10374
```
10475
76+
Add update automation such as Watchtower later, after the first run works.
77+
10578
### Step 3: Download the Feed List
10679
10780
html2rss-web needs a list of feeds to work with. Download our pre-made list:
@@ -117,48 +90,48 @@ curl https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds
11790

11891
### Step 4: Start html2rss-web
11992

120-
Now start html2rss-web:
121-
122-
**Start html2rss-web:**
123-
12493
Open a terminal in your html2rss-web folder and run:
12594

12695
```bash
12796
docker compose up -d
12897
```
12998

130-
**That's it!** 🎉 html2rss-web is now running.
99+
## First Success Check
131100

132-
**To verify it's working:**
101+
At this point, `html2rss-web` should be running.
133102

134103
1. Open your web browser
135104
2. Go to `http://localhost:3000`
136105
3. You should see the html2rss-web interface with a list of available feeds
137106

138-
**If you see the interface, congratulations!** You've successfully set up html2rss-web.
107+
If you see the interface, the install worked.
139108

140109
---
141110

142-
## Using Your Instance
111+
## What To Do First
143112

144113
### Browse Existing Feeds
145114

146-
Your html2rss-web instance comes with pre-configured feeds for popular websites. Browse the list and copy any RSS URL to your feed reader.
115+
Your instance comes with pre-configured feeds for many websites. Browse the list, open one feed, and copy its RSS URL into your feed reader.
147116

148-
### Create Auto-Sourced Feeds
117+
This is the easiest way to confirm the whole stack is healthy.
149118

150-
**Want a feed for a website that's not in the list?**
119+
### Then Choose Your Next Step
151120

152-
1. **Go to your html2rss-web interface** (http://localhost:3000)
153-
2. **Enter any website URL** you want to create a feed for
154-
3. **Click "Generate Feed"** - html2rss will automatically analyze the page
155-
4. **Copy the RSS URL** and add it to your feed reader
121+
- **Included feed works:** keep using the built-in configs and browse the [Feed Directory](/feed-directory/)
122+
- **Need a feed for a new site:** decide between auto-generation and a custom config
123+
- **Need stable, repeatable control:** move to [Creating Custom Feeds](/creating-custom-feeds)
156124

157-
**This works for most websites** without any configuration needed!
125+
<Aside type="note" title="Auto-generation is optional">
126+
Automatic feed generation is not enabled by default. If you want the "paste a URL and generate a feed"
127+
workflow, follow [Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/).
128+
</Aside>
158129

159-
### Add Custom Feeds
130+
## When To Use Each Option
160131

161-
**Need more control?** You can add custom feed configurations to your `feeds.yml` file. See our [Creating Custom Feeds](/creating-custom-feeds) guide for details.
132+
- **Use included configs** when the site already exists in the directory
133+
- **Enable automatic feed generation** when you want to try a site quickly without writing YAML
134+
- **Write a custom config** when auto-generation is incomplete or you need precise control
162135

163136
---
164137

@@ -175,11 +148,7 @@ Your html2rss-web instance comes with pre-configured feeds for popular websites.
175148

176149
## Next Steps
177150

178-
**Ready for more?**
179-
180-
- **[Browse the Feed Directory](/feed-directory/)** - See real-world examples
181-
- **[Create Custom Feeds](/creating-custom-feeds)** - Learn to write your own configurations
182-
- **[Troubleshooting Guide](/troubleshooting/troubleshooting)** - Solve common issues
183-
- **[Join the Community](https://github.com/orgs/html2rss/discussions)** - Get help and share ideas
184-
185-
**🎉 Congratulations!** You now have your own RSS feed server running.
151+
1. **[Use the included configs](/web-application/how-to/use-included-configs/)** - Start with working feeds
152+
2. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)** - Enable the quick-generate flow
153+
3. **[Create Custom Feeds](/creating-custom-feeds)** - Add and test your own YAML configs
154+
4. **[Troubleshooting Guide](/troubleshooting/troubleshooting)** - Solve startup and extraction issues

src/content/docs/index.mdx

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,21 @@ title: "Turn Any Website Into an RSS Feed - Never Miss Updates Again"
33
description: "Create RSS feeds from any website - no coding required. Turn blogs, news sites, and forums into RSS feeds you can follow in your favorite reader. Free, open source, and easy to use."
44
---
55

6-
Ever wished you could follow your favorite websites like a social media feed? The html2rss project makes it possible by creating RSS feeds for any website - even ones that don't offer them.
6+
Run `html2rss-web` with Docker, start with included feeds, and add custom configs only when you need more control.
77

88
## 🚀 Get Started in 30 Seconds
99

10-
**Try it now:** [Browse Ready-Made Feeds](/feed-directory/) | [Get Started](/getting-started)
10+
**Start here:** [Run html2rss-web with Docker](/web-application/getting-started) | [Browse working feed examples](/feed-directory/)
11+
12+
Need more control? [Write a custom feed config](/creating-custom-feeds)
13+
14+
---
15+
16+
## How It Works
17+
18+
1. **Run your own local instance** with Docker
19+
2. **Use included feeds or add your own** website targets
20+
3. **Subscribe from your RSS reader** using stable feed URLs
1121

1222
---
1323

@@ -34,30 +44,30 @@ Ever wished you could follow your favorite websites like a social media feed? Th
3444

3545
## What is html2rss?
3646

37-
html2rss is a user-friendly tool that turns any website into an RSS feed. Think of it as a translator that converts website content into a format your feed reader can understand.
47+
html2rss is a toolkit for turning websites into RSS feeds. Think of it as a translator that converts website content into a format your feed reader can understand.
3848

39-
**Two ways to use html2rss:**
49+
**Most people should start with the web application:**
4050

41-
- **🌐 Web App** - RSS feed server with auto-sourcing. Perfect for everyone
42-
- **⚙️ Ruby Gem** - The core engine that powers everything
51+
- **🌐 html2rss-web** - The easiest way to run your own feed server with Docker
52+
- **⚙️ html2rss gem** - The underlying engine, CLI, and developer interface
4353

4454
---
4555

4656
## 🎯 Choose Your Path
4757

48-
### I'm Getting Started with RSS
58+
### I want a working instance first
4959

50-
1. **[Get Started](/getting-started)** - Complete guide to using html2rss
51-
2. **[Browse Examples](/feed-directory/)** - See 100+ ready-made feeds
52-
3. **[Learn More](/about/)** - Understand how it all works
60+
1. **[Run html2rss-web with Docker](/web-application/getting-started)** - Recommended starting path
61+
2. **[Browse working feed examples](/feed-directory/)** - See what success looks like
62+
3. **[Use the included configs](/web-application/how-to/use-included-configs/)** - Start with ready-made feeds
5363

54-
### I Want to Create Custom Feeds
64+
### I need more control
5565

56-
1. **[Creating Custom Feeds](/creating-custom-feeds)** - Learn to write your own configs
57-
2. **[Ruby Gem Reference](/ruby-gem/)** - Full technical documentation
58-
3. **[Share Your Configs](/get-involved/contributing/)** - Help the community
66+
1. **[Creating Custom Feeds](/creating-custom-feeds)** - Write and test your own configs
67+
2. **[Selectors Reference](/ruby-gem/reference/selectors/)** - Learn the matching rules
68+
3. **[Strategy Reference](/ruby-gem/reference/strategy/)** - Use `browserless` for JS-heavy sites
5969

60-
### I'm a Developer
70+
### I'm building or integrating
6171

6272
1. **[Ruby Gem Reference](/ruby-gem/)** - Full API documentation
6373
2. **[Advanced Features](/ruby-gem/how-to/advanced-features/)** - Custom HTTP requests, etc.
@@ -80,6 +90,12 @@ html2rss is a user-friendly tool that turns any website into an RSS feed. Think
8090

8191
## 🔧 Common Issues?
8292

93+
**Start with Docker, not a public instance.** That gives you the most reliable path and the newest integrated behavior.
94+
8395
**Feed not working?** Check our [troubleshooting guide](/troubleshooting/troubleshooting)
96+
97+
**Need custom control?** Continue to [Creating Custom Feeds](/creating-custom-feeds)
98+
8499
**Need help?** Join our [community discussions](https://github.com/orgs/html2rss/discussions)
100+
85101
**Found a bug?** [Report it on GitHub](https://github.com/html2rss/html2rss/issues)

0 commit comments

Comments
 (0)