Repository files navigation

中文

An RSS reader running entirely from your GitHub repo.

• Free hosting onGitHub Pages.
• No need for backend. Content updates viaGitHub Actions.
• Customizable layouts and styles via templating and theming API. Just bring your HTML and CSS.
• Free and open source. No ads. No third party tracking.

Want a host-free alternative? Check out the sister project:Fjord.

• 💻Default template + Gruvbox dark |View source
• 😎Default template + Solarized dark
• ☀Default template + Solarized light
• 🔨Unstyled template for building from scratch.
• 📺YouTube feed template + Material dark
• 🎧Unstyled template for building a podcast feed

Browse allsources and more examples

1. OpenCreate a new repository from osmosfeed-template.
2. Set visibility to "Public".
   
3. Click "Create repository from template" button.

1. In the repository you just created, navigate toSettings tab >Pages section.

2. InSource option, selectgh-pages, click "Save" button. Ifgh-pages doesn't exist, wait for a couple of seconds and refresh the page. It will eventually show up.
   

3. Refresh the page until it showsYour site is published at https://<github_username>.github.io/<repo>. This may take up to a minute.
   

1. In the repository root, openosmosfeed.yaml file, click the "Pencil (Edit this file)" button to edit.

2. Remove# to uncommend thecacheUrl property, replace<github_username> with your GitHub username, and replace<repo> with your GitHub repo name.

3. 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.jsonsources:  -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/

4. Scroll to the bottom of the page, click "Commit changes" button.

5. Once the rebuild finishes, your feed will be available athttps://<github_username>.github.io/<repo>.

• Customization guide
  • Changing theme
  • Changing template
  • Add inline HTML, CSS, JavaScript
  • Add static files
• Configuration reference
• Headless usage guide

• How to contribute
• Developer guide

Yes, you can make it as frequent as you want. In the.github/workflows/update-feed.yaml file, change thecron 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 onBilling & 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 youdeploy to Netlify, there is a paid plan forpassword protection.

No. There is a known issue with GitHub, so you might have to type it until it starts to work. Seediscussion from GitHub Community andsome solutions from Stack Overflow

You can make some changes to theosmosfeed.yaml file to trigger an update. For example, add an empty comment like this# on a new line.

You can browse to thegh-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 theOsmosCraft ecosystem.

• Read the web withFjord
• Manage bookmarks withMemo
• Take notes withTundra