Skip to content

Commit 111053e

Browse files
committed
docs: update and provide correct information
1 parent 9d384fe commit 111053e

9 files changed

Lines changed: 47 additions & 36 deletions

File tree

404.html

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,18 @@
33
layout: default
44
---
55

6-
<h1>404</h1>
6+
<h1>404 - Page Not Found</h1>
77

8-
<p><strong>Page not found :(</strong></p>
9-
<p>The requested page could not be found.</p>
8+
<p><strong>Sorry, the page you're looking for doesn't exist.</strong></p>
9+
10+
<p>Here are some helpful links to get you back on track:</p>
11+
12+
<ul>
13+
<li><a href="{{ '/' | relative_url }}">Home</a> - Start from the beginning</li>
14+
<li><a href="{{ '/web-application/getting-started' | relative_url }}">Getting Started</a> - Learn how to use html2rss</li>
15+
<li><a href="{{ '/ruby-gem' | relative_url }}">Ruby Gem Documentation</a> - Developer resources</li>
16+
<li><a href="{{ '/feed-directory' | relative_url }}">Feed Directory</a> - Browse available feeds</li>
17+
<li><a href="{{ '/get-involved' | relative_url }}">Get Involved</a> - Join the community</li>
18+
</ul>
19+
20+
<p>If you think this is an error, please <a href="https://github.com/html2rss/html2rss.github.io/issues">report it on GitHub</a>.</p>

about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ For insights into our ongoing development, project roadmap, and how you can get
3131

3232
`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.
3333

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

bin/data-update

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ def extract_default_parameters(parameters)
1616
return {} unless parameters.is_a?(Hash)
1717

1818
parameters.each_with_object({}) do |(param_name, param_config), defaults|
19-
if param_config.is_a?(Hash) && param_config['default']
20-
defaults[param_name] = param_config['default']
21-
end
19+
defaults[param_name] = param_config['default'] if param_config.is_a?(Hash) && param_config['default']
2220
end
2321
end
2422

get-involved/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Engage with the `html2rss` project. Contribute and connect with the community.
1414
- [**Project Roadmap**]({{ 'https://github.com/orgs/html2rss/projects/3/views/1' }}): View current work, plans, and priorities.
1515
- [**Report Bugs & Discuss Features**]({{ '/get-involved/issues-and-features' | relative_url }}): Report bugs or propose features.
1616
- [**Join Community Discussions**]({{ '/get-involved/discussions' | relative_url }}): Connect with users and contributors.
17-
- [**Contribute to html2rss**]({{ '/contributing' | relative_url }}): Contribute code, documentation, or feed configurations.
17+
- [**Contribute to html2rss**]({{ '/get-involved/contributing' | relative_url }}): Contribute code, documentation, or feed configurations.

html2rss-configs/index.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -108,19 +108,6 @@ selectors:
108108

109109
## Advanced Techniques
110110

111-
### Handling Pagination
112-
113-
To aggregate content from multiple pages, use the `pagination` option within the `items` selector.
114-
115-
```yaml
116-
selectors:
117-
items:
118-
selector: ".post-listing .post"
119-
pagination:
120-
selector: ".pagination .next-page"
121-
limit: 5 # Optional: sets the maximum number of pages to follow
122-
```
123-
124111
### Dynamic Feeds with Parameters
125112

126113
Use the `parameters` block to create flexible configs. This is useful for feeds based on search terms, categories, or regions.
@@ -135,6 +122,15 @@ parameters:
135122
channel:
136123
url: "https://news.example.com/search?q={query}"
137124
title: "News results for '{query}'"
125+
126+
selectors:
127+
items:
128+
selector: ".article"
129+
title:
130+
selector: "h2 a"
131+
url:
132+
selector: "h2 a"
133+
extractor: "href"
138134
```
139135

140136
---

ruby-gem/how-to/scraping-json.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ headers:
8989
channel:
9090
url: "http://domainname.tld/whatever.json"
9191
selectors:
92+
items:
93+
selector: "array > object"
9294
title:
9395
selector: "foo"
9496
```

ruby-gem/installation.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide will walk you through the process of installing html2rss on your syst
1313

1414
### Prerequisites
1515

16-
- **Ruby:** html2rss is built with Ruby. Ensure you have Ruby installed (version 3.3 or higher recommended). You can check your Ruby version by running `ruby -v` in your terminal. If you don't have Ruby, visit [ruby-lang.org](https://www.ruby-lang.org/en/documentation/installation/) for installation instructions.
16+
- **Ruby:** html2rss is built with Ruby. Ensure you have Ruby installed (version 3.2 or higher required). You can check your Ruby version by running `ruby -v` in your terminal. If you don't have Ruby, visit [ruby-lang.org](https://www.ruby-lang.org/en/documentation/installation/) for installation instructions.
1717
- **Bundler (Recommended):** Bundler is a Ruby gem that manages your application's dependencies. It's highly recommended for a smooth installation. Install it with `gem install bundler`.
1818

1919
---
@@ -43,15 +43,13 @@ Then, run `bundle install` in your project directory.
4343

4444
---
4545

46-
### Method 3: Docker (For Containerized Environments)
46+
### Method 3: GitHub Codespaces (For Cloud Development)
4747

48-
For a more isolated and reproducible environment, you can use the official html2rss Docker image.
48+
For a quick start without local setup, you can develop html2rss directly in your browser using GitHub Codespaces:
4949

50-
```bash
51-
docker pull html2rss/html2rss
52-
```
50+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?repo=html2rss/html2rss)
5351

54-
You can then run html2rss commands within a Docker container. Refer to the [Docker Hub page](https://hub.docker.com/r/html2rss/html2rss) for detailed usage.
52+
The Codespace comes pre-configured with Ruby 3.4, all dependencies, and VS Code extensions ready to go!
5553

5654
---
5755

ruby-gem/reference/selectors.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ selectors:
4242
While you can define any named selector, only the following are used in the final RSS feed:
4343

4444
| RSS 2.0 Tag | `html2rss` Name |
45-
| ------------- | --------------- |
45+
| ------------- | --------------- | ------------------------------ |
4646
| `title` | `title` |
4747
| `description` | `description` |
4848
| `link` | `url` |
@@ -51,17 +51,19 @@ While you can define any named selector, only the following are used in the fina
5151
| `guid` | `guid` |
5252
| `enclosure` | `enclosure` |
5353
| `pubDate` | `published_at` |
54-
| `comments` | `comments` |
54+
| `comments` | `comments` | ⚠️ _Not currently implemented_ |
5555

5656
## Selector Options
5757

5858
Each selector can be configured with the following options:
5959

60-
| Name | Description |
61-
| -------------- | ------------------------------------------------ |
62-
| `selector` | The CSS selector for the target element. |
63-
| `extractor` | The extractor to use for this selector. |
64-
| `post_process` | A list of post-processors to apply to the value. |
60+
| Name | Description |
61+
| -------------- | -------------------------------------------------------- |
62+
| `selector` | The CSS selector for the target element. |
63+
| `extractor` | The extractor to use for this selector. |
64+
| `attribute` | The attribute name (required for `attribute` extractor). |
65+
| `static` | The static value (required for `static` extractor). |
66+
| `post_process` | A list of post-processors to apply to the value. |
6567

6668
### Extractors
6769

@@ -126,6 +128,10 @@ To add an enclosure (e.g., an image, audio, or video file) to an item, use the `
126128

127129
```yml
128130
selectors:
131+
items:
132+
selector: ".post"
133+
title:
134+
selector: "h2"
129135
enclosure:
130136
selector: "audio"
131137
extractor: "attribute"

ruby-gem/reference/stylesheets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can add multiple stylesheets to your configuration:
1717

1818
```yaml
1919
stylesheets:
20-
- href: "/path/to/style.xls"
20+
- href: "/path/to/style.xsl"
2121
media: "all"
2222
type: "text/xsl"
2323
- href: "https://example.com/rss.css"

0 commit comments

Comments
 (0)