An RSS reader running entirely from your GitHub repo.
Want a host-free alternative? Check out the sister project: Fjord.
Browse all sources and more examples
In the repository you just created, navigate to Settings tab > Pages section.
In Source option, select gh-pages
, click "Save" button. If gh-pages
doesn't exist, wait for a couple of seconds and refresh the page. It will eventually show up.
Refresh the page until it shows Your site is published at https://<github_username>.github.io/<repo>
. This may take up to a minute.
In the repository root, open osmosfeed.yaml
file, click the "Pencil (Edit this file)" button to edit.
Remove #
to uncommend the cacheUrl
property, replace <github_username>
with your GitHub username, and replace <repo>
with your GitHub repo name.
In the sources, update the items to the sources you want to follow. The final content of the file should look similar to this:
cacheUrl: https://<github_username>.github.io/<repo>/cache.json
sources:
- href: https://my-rss-source-1/feed/
- href: https://my-rss-source-2/rss/
- href: https://my-rss-source-3/feed
- href: https://my-rss-source-4/news/rss
- href: https://my-rss-source-5/rss/
Scroll to the bottom of the page, click "Commit changes" button.
Once the rebuild finishes, your feed will be available at https://<github_username>.github.io/<repo>
.
Yes, you can make it as frequent as you want. In the
.github/workflows/update-feed.yaml
file, change the cron schedule. But be aware that there is a limit to the free tier of GitHub Actions. My rough estimate shows that even with hourly update, you should still have plenty of unused time. You can monitor spending on Billing & plans page in Account settings.
It is not possible with GitHub Pages. However, if you move the site to a different hosting service, you should be able to set up authorization on the host level. For example, if you deploy to Netlify, there is a paid plan for password protection.
index.html
at the end of the URL?No. There is a known issue with GitHub, so you might have to type it until it starts to work. See discussion from GitHub Community and some solutions from Stack Overflow
You can make some changes to the
osmosfeed.yaml
file to trigger an update. For example, add an empty comment like this#
on a new line.
You can browse to the
gh-pages
branch on GitHub athttps://github.com/<owner>/<repo>/tree/gh-pages
. Manually delete thecache.json
file. Then trigger a manual site update.
Browse other projects from the OsmosCraft ecosystem.