Skip to content

Commit 1051ff9

Browse files
committed
.
1 parent 39ba614 commit 1051ff9

12 files changed

Lines changed: 238 additions & 65 deletions

File tree

astro.config.mjs

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,19 +127,16 @@ export default defineConfig({
127127
link: "/",
128128
},
129129
{
130-
label: "About",
131-
link: "/about",
130+
label: "Common Use Cases",
131+
link: "/common-use-cases",
132132
},
133133
{
134134
label: "Feed Directory",
135135
link: "/feed-directory/",
136136
},
137-
{
138-
label: "Creating Custom Feeds",
139-
link: "/html2rss-configs",
140-
},
141137
{
142138
label: "Web Application",
139+
collapsed: true,
143140
items: [
144141
"web-application",
145142
"web-application/getting-started",
@@ -159,6 +156,7 @@ export default defineConfig({
159156
},
160157
{
161158
label: "Ruby Gem",
159+
collapsed: true,
162160
items: [
163161
"ruby-gem",
164162
"ruby-gem/installation",
@@ -176,12 +174,22 @@ export default defineConfig({
176174
},
177175
],
178176
},
177+
{
178+
label: "About",
179+
link: "/about",
180+
},
181+
{
182+
label: "Creating Custom Feeds",
183+
link: "/html2rss-configs",
184+
},
179185
{
180186
label: "Get Involved",
187+
collapsed: false,
181188
autogenerate: { directory: "get-involved" },
182189
},
183190
{
184191
label: "Support",
192+
collapsed: true,
185193
autogenerate: { directory: "support" },
186194
},
187195
],

src/content/docs/about.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: About html2rss
3-
description: Learn about html2rss, our mission, principles, and the team behind this open-source project.
3+
description: Learn about html2rss, the open-source RSS feed generator that helps you follow any website. Discover our mission, principles, and the team behind this powerful tool.
44
---
55

66
`html2rss` is an open-source project dedicated to empowering you to take control of your web content. In an age where many websites don't offer traditional RSS feeds, `html2rss` provides a robust and flexible solution to convert almost any HTML content into a structured RSS format.
77

8-
Started in 2018, the project has evolved into a comprehensive suite of tools designed to help you create and consume RSS feeds effortlessly.
8+
Since its founding in 2018, the project has evolved into a comprehensive suite of tools designed to help you create and consume RSS feeds effortlessly.
99

1010
---
1111

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
title: "Common Use Cases"
3+
description: "See how people use html2rss to stay updated with their favorite websites. Real examples for personal and business use cases."
4+
---
5+
6+
Discover how people are using html2rss to take control of their web content consumption. These real-world examples show the power and flexibility of creating custom RSS feeds.
7+
8+
---
9+
10+
## Personal Use Cases
11+
12+
### Following Your Favorite Bloggers
13+
14+
Many bloggers don't offer RSS feeds, but you can create them with html2rss. Follow writers you love without relying on social media algorithms.
15+
16+
**Example:** Create a feed for a personal blog that only posts to social media.
17+
18+
### Job Hunting
19+
20+
Track job postings from multiple company websites in one place. Never miss an opportunity again.
21+
22+
**Example:** Follow job boards, company career pages, and industry-specific job sites.
23+
24+
### Local News
25+
26+
Follow your local newspaper or community website to stay informed about your neighborhood.
27+
28+
**Example:** Create feeds for local news sites, community forums, and city government updates.
29+
30+
### Academic Research
31+
32+
Follow new papers and research in your field from multiple sources.
33+
34+
**Example:** Track arXiv submissions, journal publications, and conference proceedings.
35+
36+
### Product Updates
37+
38+
Get notified when software you use releases updates, new features, or security patches.
39+
40+
**Example:** Follow product blogs, changelog pages, and release notes.
41+
42+
### Hobby Communities
43+
44+
Follow forums, communities, and websites related to your hobbies and interests.
45+
46+
**Example:** Track gaming forums, photography communities, or cooking blogs.
47+
48+
---
49+
50+
## Business Use Cases
51+
52+
### Competitor Monitoring
53+
54+
Track what your competitors are posting about - new products, features, or announcements.
55+
56+
**Example:** Follow competitor blogs, press releases, and social media updates.
57+
58+
### Industry News
59+
60+
Follow multiple industry publications in one feed to stay ahead of trends.
61+
62+
**Example:** Aggregate news from industry blogs, trade publications, and thought leaders.
63+
64+
### Customer Support
65+
66+
Monitor customer feedback and support requests across different platforms.
67+
68+
**Example:** Track support forums, review sites, and social media mentions.
69+
70+
### Content Marketing
71+
72+
Follow industry influencers and competitors for content inspiration.
73+
74+
**Example:** Track competitor blogs, industry newsletters, and thought leadership content.
75+
76+
---
77+
78+
## Technical Use Cases
79+
80+
### API Monitoring
81+
82+
Track API documentation updates and changelogs.
83+
84+
**Example:** Follow API documentation sites, developer blogs, and changelog pages.
85+
86+
### Security Updates
87+
88+
Monitor security advisories and vulnerability reports.
89+
90+
**Example:** Track security blogs, CVE databases, and vendor security pages.
91+
92+
### Open Source Projects
93+
94+
Follow multiple open source projects and their updates.
95+
96+
**Example:** Track project blogs, release notes, and community discussions.
97+
98+
---
99+
100+
## Getting Started with Your Use Case
101+
102+
1. **Identify the websites** you want to follow
103+
2. **Check our [Feed Directory](/feed-directory/)** to see if feeds already exist
104+
3. **Try the [Web App](/web-application/getting-started)** to create feeds easily
105+
4. **Learn advanced techniques** with our [Config Guide](/html2rss-configs/)
106+
107+
---
108+
109+
## Need Help?
110+
111+
- **Can't find what you're looking for?** [Browse our Feed Directory](/feed-directory/)
112+
- **Want to create custom feeds?** [Try the Web App](/web-application/getting-started)
113+
- **Need advanced features?** [Check our Ruby Gem docs](/ruby-gem/)
114+
- **Have questions?** [Join our community discussions](https://github.com/orgs/html2rss/discussions)

src/content/docs/html2rss-configs.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
title: Creating Custom RSS Feeds
3-
description: Learn how to create custom RSS feeds using html2rss configuration files
3+
description: Learn how to create custom RSS feeds using html2rss configuration files. Step-by-step guide for turning any website into an RSS feed with simple YAML configs.
44
---
55

66
Want to create RSS feeds for websites that don't offer them? This guide shows you how to write simple configuration files.
77

8-
**New to html2rss?** Start with the [web app](/web-application/getting-started) or [browse existing feeds](/feed-directory/) first.
8+
**Getting started?** Start with the [web app](/web-application/getting-started) or [browse existing feeds](/feed-directory/) first.
99

1010
---
1111

1212
## Quick Start
1313

1414
**Need a feed right now?**
15+
1516
1. **[Try the web app](/web-application/getting-started)** - No coding required
1617
2. **[Browse ready-made feeds](/feed-directory/)** - Use what others created
1718
3. **Create a config** - When you need custom control (see below)
@@ -23,6 +24,7 @@ Want to create RSS feeds for websites that don't offer them? This guide shows yo
2324
## How It Works
2425

2526
A config file is a simple "recipe" that tells html2rss:
27+
2628
1. **Which website** to look at
2729
2. **What content** to find
2830
3. **How to organize** it into an RSS feed
@@ -32,6 +34,7 @@ A config file is a simple "recipe" that tells html2rss:
3234
This tells html2rss basic information about your feed - like giving it a name and telling it which website to look at.
3335

3436
**Example:**
37+
3538
```yaml
3639
channel:
3740
url: https://example.com/blog
@@ -45,6 +48,7 @@ This says: "Look at this website and call the feed 'My Awesome Blog'"
4548
This is where you tell the html2rss engine exactly what to find on the page. You use CSS selectors (like you might use in web design) to point to specific parts of the webpage.
4649

4750
**Example:**
51+
4852
```yaml
4953
selectors:
5054
items:
@@ -92,6 +96,7 @@ selectors:
9296
## Troubleshooting
9397

9498
**Common issues:**
99+
95100
- **No items found?** Check your selectors with browser tools (F12)
96101
- **Invalid YAML?** Use spaces, not tabs
97102
- **Website not loading?** Check the URL
@@ -125,16 +130,19 @@ selectors:
125130
### What's Next?
126131

127132
**For Beginners:**
133+
128134
- **[Browse the Feed Directory](/feed-directory/)** - See real-world examples
129135
- **[Try html2rss-web](/web-application/getting-started)** - Create feeds without coding
130136
- **[Learn more about selectors](/ruby-gem/reference/selectors/)** - Master CSS selectors
131137

132138
**For Contributors:**
139+
133140
- **[Submit your config via GitHub Web](https://github.com/html2rss/html2rss-configs)** - No Git knowledge required!
134141
- **[Browse existing configs](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs)** - See real examples
135142
- **[Join discussions](https://github.com/orgs/html2rss/discussions)** - Connect with other users
136143

137144
**For Developers:**
145+
138146
- **[Ruby Gem Documentation](/ruby-gem/)** - Full API reference
139147
- **[Advanced Features](/ruby-gem/how-to/advanced-features/)** - Learn advanced techniques
140148
- **[Custom HTTP Requests](/ruby-gem/how-to/custom-http-requests/)** - Handle complex scenarios

src/content/docs/index.mdx

Lines changed: 63 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,85 @@
11
---
2-
title: "Turn Any Website Into an RSS Feed"
3-
description: "html2rss brings back RSS. It is an open source project with decentralized instances. These instances generate RSS feeds for websites that do not offer them."
2+
title: "Turn Any Website Into an RSS Feed - Never Miss Updates Again"
3+
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

66
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.
77

8+
## 🚀 Get Started in 30 Seconds
9+
10+
**Try it now:** [Browse Ready-Made Feeds](/feed-directory/) | [Create Your First Feed](/web-application/getting-started)
11+
812
---
913

10-
## Why Use RSS Feeds?
14+
## Why RSS Still Matters Today
15+
16+
**Real examples of what you can do:**
1117

12-
Instead of visiting 20 different websites every day, you can:
18+
- Follow your favorite blogs without social media algorithms
19+
- Get notified when your local news site posts about your neighborhood
20+
- Track job postings from multiple company websites
21+
- Monitor product updates from software vendors
22+
- Follow academic papers from your field
1323

14-
- **Get all updates in one place** - your feed reader
15-
- **Never miss new content** - automatic notifications
16-
- **Save time** - no more manual checking
17-
- **Stay organized** - categorize and filter content
24+
**RSS vs Social Media:**
25+
26+
-**No algorithms** deciding what you see
27+
-**No ads** or sponsored content
28+
-**Works with any feed reader** you choose
29+
-**Your data stays private**
30+
-**Never miss updates** - automatic notifications
31+
-**Save time** - no more manual checking
1832

1933
---
2034

2135
## What is html2rss?
2236

23-
html2rss is a user-friendly web application 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.
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.
2438

2539
**Two ways to use html2rss:**
26-
- **html2rss-web** - Easy-to-use web application (recommended for most users)
27-
- **html2rss Ruby gem** - For developers and advanced users
40+
41+
- **🌐 Web App** - Point, click, done! Perfect for everyone
42+
- **⚙️ Ruby Gem** - For developers who want to code their own feeds
2843

2944
---
3045

31-
## Quick Start
46+
## 🎯 Choose Your Path
47+
48+
### I'm Getting Started with RSS
49+
50+
1. **[See Examples First](/feed-directory/)** - Browse 100+ ready-made feeds
51+
2. **[Try the Web App](/web-application/getting-started)** - Create feeds without coding
52+
3. **[Learn More](/about/)** - Understand how it all works
53+
54+
### I Want to Create Custom Feeds
55+
56+
1. **[Web App](/web-application/getting-started)** - Start with the easy interface
57+
2. **[Ruby Gem](/ruby-gem/installation)** - For advanced customization
58+
3. **[Config Guide](/html2rss-configs/)** - Learn to write your own configs
3259

33-
**Option 1: Browse Ready-Made Feeds (Easiest)**
34-
1. **[Feed Directory](/feed-directory/)** - See what's already available
35-
2. **Copy the RSS URL** and add it to your feed reader
60+
### I'm a Developer
61+
62+
1. **[Ruby Gem Docs](/ruby-gem/)** - Full API reference
63+
2. **[Advanced Features](/ruby-gem/how-to/advanced-features/)** - Custom HTTP requests, etc.
64+
3. **[Contribute](/get-involved/contributing/)** - Help improve the project
65+
66+
---
67+
68+
## 🌟 What People Are Using html2rss For
69+
70+
- **News & Blogs:** Follow your favorite writers without social media
71+
- **Job Hunting:** Track job postings from multiple company sites
72+
- **Product Updates:** Get notified when software you use gets updated
73+
- **Academic Research:** Follow new papers in your field
74+
- **Local News:** Stay updated on your neighborhood and city
75+
- **Hobby Communities:** Follow forums and communities you care about
76+
77+
[Browse all examples in our Feed Directory →](/feed-directory/)
78+
79+
---
3680

37-
**Option 2: Create Your Own Feeds**
38-
1. **[Try html2rss-web](/web-application/getting-started)** - No technical knowledge required
39-
2. **[Install your own instance](/web-application/installation)** - For advanced users
81+
## 🔧 Common Issues?
4082

41-
**New to RSS?** Start with the [Feed Directory](/feed-directory/) to see examples, then try [html2rss-web](/web-application/getting-started) to create your own feeds.
83+
**Feed not working?** Check our [troubleshooting guide](/support/troubleshooting)
84+
**Need help?** Join our [community discussions](https://github.com/orgs/html2rss/discussions)
85+
**Found a bug?** [Report it on GitHub](https://github.com/html2rss/html2rss/issues)

src/content/docs/ruby-gem/how-to/managing-feed-configs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can define global settings that apply to all feeds, and then define individu
1212
```yml
1313
# Global settings
1414
headers:
15-
"User-Agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_3_1 like Mac OS X) AppleWebKit/603.1.30 (KHTML, like Gecko) Version/10.0 Mobile/14E304 Safari/602.1"
15+
"User-Agent": "Mozilla/5.0 (compatible; html2rss/1.0; Mobile)"
1616
"Accept": "text/html"
1717

1818
# Feed-specific settings

src/content/docs/ruby-gem/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Ruby Gem"
3-
description: "This section provides comprehensive documentation for the html2rss Ruby gem."
3+
description: "Complete documentation for the html2rss Ruby gem. Create custom RSS feeds programmatically with full control over scraping and feed generation."
44
sidebar:
55
label: "Overview"
66
---
@@ -9,7 +9,7 @@ This section provides comprehensive documentation for the `html2rss` Ruby gem.
99

1010
## Getting Started
1111

12-
If you are new to `html2rss`, we recommend starting with the [tutorials](/ruby-gem/tutorials).
12+
If you are getting started with `html2rss`, we recommend starting with the [tutorials](/ruby-gem/tutorials).
1313

1414
## Documentation Sections
1515

0 commit comments

Comments
 (0)