Skip to content
Static RSS reader generator
Go HTML Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
feed
funcs
.gitignore
LICENSE.md
Makefile
README.md
fetch.go
generate.go
go.mod
go.sum
main.go
render.go
screenshot.png
template.go
template.html

README.md

goread

Go Report Card

goread generates static HTML files showing previews of subscribed RSS feeds. Similar to rawdog and curn it can be used as a cronjob. Configuration happens through a simple YAML file containing categories and their subscriptions. It comes with a built in template that can be overwritten.

See the Screenshot.

Basic Usage

Create a YAML file with the following format:

golang:
  - https://blog.golang.org/feed.atom
  - https://campoy.cat/index.xml
  - https://medium.com/feed/@matryer

podcasts:
  - https://feeds.feedburner.com/SchrottcastTitusJonas
  - https://freakshow.fm/feed/m4a

By default, goread will look for a feeds.yml in the current directory and renders its HTML files there too. This can be changed by using the -in and -out flags. Note that -in expects a filename and -out a directory path.

$ goread -in ~/.goread.yml -out /var/www/html
$

Use a custom template

The -template flag can be used to replace the defaut template. The default template can be used as an starting point for a custom one.

$ goread -template template.html
$

Help

$ goread -help
Usage of goread:
  -in string
        Path to a list of feed URLs (default "feeds.yml")
  -max-items int
        Max number of items (default 100)
  -n int
        Number of concurrent downloads (default 5)
  -out string
        Path to generated HTML (default ".")
  -template string
        Path to the HTML template

Development

Use go generate to embed the default template. During development, you can use the -template flag instead.

You can’t perform that action at this time.