NotCraft::NotFeed
An RSS reader running entirely from your GitHub repo.
- Free hosting on GitHub Pages. No ads. No third party tracking.
- No need for backend. Content updates via GitHub Actions.
- Customizable layouts and styles via templating and theming API. Just bring your HTML and CSS.
- Free and open source. No third-party tracking.
How to use it?
Github Pages
-
Use the NotFeed-Template generate your own repository.
-
In the repository root, open
Config.toml
file, click the "Pencil (Edit this file)" button to edit. -
Remove
#
to uncommend thecacheUrl
property, replace
with your GitHub username, and replace
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:
site_title = "ArxivDaily" cache_max_days = 7 sources = [ "https://export.arxiv.org/rss/cs.CL" ] # proxy = "http://127.0.0.1:7890" ## Optional: default is None # statics_dir = "statics" ## Optional: default is "statics" # templates_dir = "includes" ## Optional: default is "includes" # cache_url = "https://GITHUB_USERNAME.github.io/REPO_NAME/cache.json" # minify = true # [scripts] # highlight = "scripts/highlight.rhai"
-
Scroll to the bottom of the page, click "Commit changes" button.
-
Once the rebuild finishes, your feed will be available at
https://
.github.io/
Localhost
- Clone the NotFeed-Template repository.
- Edit
Config.toml
file. - Run
notfeed
- build:
notfeed build
- serve:
notfeed serve --addr 127.0.0.1 --port 8080
or simplynotfeed serve
- build:
TODO
- When build error should retry or skip.
- Fix If minify is true, the statics dir will be flattened.
- Generate atom format file.
- Refactor render structs.
Thanks
- Inspired by osmos::feed