Skip to content

feat: improve example feed config in feed.yml and link to it #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gildesmarais merged 1 commit into from
Dec 24, 2022
Merged

feat: improve example feed config in feed.yml and link to it #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The functionality of scraping websites and building the RSS is provided by the R
docker run -p 3000:3000 gilcreator/html2rss-web
```

and open <http://127.0.0.1:3000/> in your browser.
and open <http://127.0.0.1:3000/> in your browser and click onto the example feed link.

This is the quickest way to get started. However, it's also the one with least flexibility: it doesn't allow to use custom feed configs and doesn't update automatically.

Expand Down Expand Up @@ -73,12 +73,12 @@ html2rss-web comes with many feed configs out of the box. [See file list of all

To use a config from there, build the URL like this:

The _feed config_ you'd like to use:
`lib/html2rss/configs/domainname.tld/whatever.yml`
The _feed config_ you'd like to use:
`lib/html2rss/configs/domainname.tld/whatever.yml`
`‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌^^^^^^^^^^^^^^^^^^^^^^^^^^^`

The corresponding URL:
`http://localhost:3000/domainname.tld/whatever.rss`
The corresponding URL:
`http://localhost:3000/domainname.tld/whatever.rss`
`‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ^^^^^^^^^^^^^^^^^^^^^^^^^^^`

## How to build your RSS feeds
Expand Down
21 changes: 12 additions & 9 deletions config/feeds.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
stylesheets:
- href: '/rss.xsl'
media: 'all'
type: 'text/xsl'
- href: "/rss.xsl"
media: "all"
type: "text/xsl"
headers:
"User-Agent": "Mozilla/5.0 (Windows NT 10.0; rv:68.0) Gecko/20100101 Firefox/68.0"
"User-Agent": "Mozilla/5.0 (Windows NT 10.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"
feeds:
# your custom feeds go here:
example:
channel:
url: https://html2rss.github.io/
url: https://github.com/html2rss/html2rss-web/commits/master
title: Latest commits on html2rss-web's master branch.
ttl: 120
selectors:
items:
selector: '[role=main]'
selector: "ol > li > div"
title:
selector: 'h1'
description:
selector: 'p'
selector: "p"
link:
selector: "a"
extractor: "href"
5 changes: 5 additions & 0 deletions views/index.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
instance
</h1>

<p>
Check out the
<a href="./example.rss" rel="noreferrer nofollow noindex">example.rss</a>.
</p>

<p>
Find out more about the html2rss ecosystem
<a href="https://html2rss.github.io/">at the project website</a>.
Expand Down