Skip to content

Commit f77cbd1

Browse files
committed
feat(docs): Restructure into Ruby Gem and Web App sections
Reorganize the documentation to create a clear distinction between the `html2rss` Ruby Gem and the standalone Web Application. This improves navigation and helps users find content relevant to their specific use case. - Move all existing gem-related documentation (getting started, configuration, examples) into a new `/ruby-gem` directory. - Add a new, comprehensive documentation section for the Web Application under `/web-application`. - Update site-wide navigation, internal links, and page front matter to align with the new structure. - Update gem dependencies in `Gemfile.lock`.
1 parent 266f5e1 commit f77cbd1

38 files changed

Lines changed: 463 additions & 160 deletions

_config.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ aux_links:
2424
"GitHub":
2525
- "https://github.com/html2rss"
2626

27-
header_pages:
28-
- configs/index.html
29-
- contributing.md
3027

3128
# Footer "Edit this page on GitHub" link text
3229
gh_edit_link: true # show or hide edit this page link

about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ The `html2rss` project is more than just a single tool. It's a collection of too
4141

4242
`html2rss` is maintained by a dedicated group of volunteers and contributors from around the world. We are passionate about open source and committed to continuously improving the project.
4343

44-
Want to join us? Check out our [Contributing Guide]({{ '/contributing/' | relative_url }})!
44+
Want to join us? Check out our [Contributing Guide]({{ '/contributing' | relative_url }})!

configuration/index.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

examples/custom-http-requests.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

examples/handling-dynamic-content.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

getting-started/index.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

index.md

Lines changed: 9 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,38 @@ title: Home
44
nav_order: 1
55
---
66

7-
# Welcome to html2rss!
8-
9-
**Transform any website into a custom RSS feed.**
7+
# Create RSS Feeds for Any Website
108

119
Tired of missing updates from websites that don't offer RSS feeds? `html2rss` is a powerful and flexible tool that lets you create your own RSS feeds for almost any website.
1210

13-
Whether you're a developer, a content curator, or just someone who wants to stay on top of the latest news, `html2rss` gives you the power to control your information flow.
11+
[**🚀 Get Started with the Web App!**]({{ '/web-application/getting-started' | relative_url }})
1412

1513
---
1614

17-
## How it Works
15+
## The html2rss Ecosystem
1816

19-
`html2rss` makes it easy to create custom RSS feeds in just a few steps:
17+
`html2rss` is a suite of tools designed to help you create and manage RSS feeds.
2018

21-
1. **Install `html2rss`:** Get up and running in minutes with a simple gem installation.
22-
2. **Choose your scraper:**
23-
- Use the **`auto_source` scraper** to automatically find and extract content from a website.
24-
- Use the **`selectors` scraper** for more control, allowing you to specify exactly what content to extract using CSS selectors.
25-
3. **Generate your feed:** Run a simple command to generate your custom RSS feed.
26-
4. **Stay updated:** Use your favorite RSS reader to subscribe to your new feed and never miss an update.
19+
* **[html2rss-web]({{ '/web-application' | relative_url }}):** A user-friendly web application that makes it easy to create, manage, and share RSS feeds. This is the recommended starting point for most users.
20+
* **[html2rss (Ruby Gem)]({{ '/ruby-gem' | relative_url }}):** The core library that powers the web application. It provides a powerful and flexible command-line interface for creating custom RSS feeds.
21+
* **[html2rss-configs](https://github.com/html2rss/html2rss-configs):** A community-driven repository of pre-built feed configurations for popular websites.
2722

2823
---
2924

30-
### Key Features
25+
## Key Features
3126

27+
- **User-Friendly Web Interface:** The `html2rss-web` application provides a simple and intuitive interface for managing your feeds.
3228
- **Automatic Feed Generation:** The `auto_source` scraper intelligently finds and extracts content from websites, so you can create feeds with minimal effort.
3329
- **Precise Content Extraction:** Use familiar CSS selectors to target the exact content you want to include in your feed.
34-
- **JSON Support:** Scrape and handle JSON responses from APIs and other web services.
3530
- **JavaScript Rendering:** Use a headless browser to render JavaScript-heavy websites and extract content that isn't available in the initial HTML.
36-
- **Customizable HTTP Headers:** Set custom HTTP headers for your requests, allowing you to access protected content or interact with APIs.
3731
- **Open Source:** `html2rss` is free to use, modify, and contribute to.
3832

3933
---
4034

41-
### Get Started in Minutes
42-
43-
Ready to create your first custom RSS feed? Our comprehensive documentation will guide you through the process, from installation to advanced configurations.
44-
45-
[**🚀 Get Started Now!**]({{ '/getting-started/' | relative_url }})
46-
47-
---
48-
49-
### Examples & Recipes
50-
51-
Explore our collection of pre-built recipes and examples to see `html2rss` in action and get inspiration for your own feeds.
52-
53-
[**📚 Browse Examples**]({{ '/examples/' | relative_url }})
54-
55-
---
56-
5735
### Join the Community
5836

5937
Have a question, an idea, or a success story to share? Join the `html2rss` community on GitHub!
6038

6139
- **[Discussions](https://github.com/orgs/html2rss/discussions):** Ask questions, share ideas, and connect with other users.
6240
- **[Issues](https://github.com/html2rss/html2rss/issues):** Report bugs and request new features.
6341
- **[Contribute](https://github.com/html2rss/html2rss/fork):** Fork the repository and submit your own improvements.
64-
65-
---
66-
67-
### Need Help?
68-
69-
Check out our [Troubleshooting Guide]({{ '/support/troubleshooting/' | relative_url }}) or [Contact Us]({{ '/support/contact/' | relative_url }}) for support.
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
layout: default
33
title: Auto Source
4-
nav_order: 4
4+
nav_order: 1
55
parent: Configuration
6+
grand_parent: Ruby Gem
7+
permalink: /ruby-gem/configuration/auto_source
68
---
79

810
# `auto_source`
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
layout: default
33
title: Channel
4-
nav_order: 1
4+
nav_order: 2
55
parent: Configuration
6+
grand_parent: Ruby Gem
7+
permalink: /ruby-gem/configuration/channel
68
---
79

810
# `channel`
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
22
layout: default
33
title: Headers
4-
nav_order: 1
4+
nav_order: 3
55
parent: Configuration
6+
grand_parent: Ruby Gem
7+
permalink: /ruby-gem/configuration/headers
68
---
79

810
# `headers`
@@ -17,7 +19,7 @@ headers:
1719
1820
You can also set headers for APIs that require authorization or custom headers.
1921
20-
Dynamic parameters can be used in headers to pass values at runtime. See [Advanced Topics](/configuration/advanced-topics/) for more details.
22+
Dynamic parameters can be used in headers to pass values at runtime. See [Dynamic Parameters]({{ '/ruby-gem/examples/dynamic-parameters' | relative_url }}) for more details.
2123
2224
## Example Configuration
2325

0 commit comments

Comments
 (0)