Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cupid

dotnil93ISC1.0.0-beta

An alternative of venus the feed aggregator

readme

Cupid

An alternative of venus the feed aggregator.

$ npm install cupid -g
$ cat > planet.json <<EOF
{
  "title": "Example Planet",
  "uri": "http://planet.example.com",
  "feeds": [
    { "uri": "http://cyj.me/feed/atom.xml" }
  ]
}
EOF
$ mkdir src
$ touch src/index.html
$ touch src/feed.xml
$ cupid build               # will render views/{index.html,feed.xml} into cwd.
$ DEBUG=cupid cupid build   # enable debugging logs

cupid-build

$ cupid-build --help

  Examples:

  $ cupid-build
  $ cupid-build -c 20
  $ cupid-build some-planet -d /path/to/webroot
  $ cupid-build --timeout 5000

-c, --count

The maximum number of articles per feed.

-C, --copy

Build in copy mode. In this mode, .html and .xml files are skipped while renderring the site. Only the static files will be copied into destination folder.

➜  planet git:(master) DEBUG=cupid cupid build -C
  cupid writing to /tmp/planet/target +0ms
  cupid wrote app.css +6ms
  cupid wrote app.js +3ms

-d, --destination

The destination folder of the build result, which defaults to ./target.

-t, --timeout

The timeout on fetching and parsing combined per feed.

changelog

1.0.0 / 2016-12-??

A complete rewritten of the original cupid@0.1:

  • New: use DEBUG=cupid to toggle log behaviours
  • New: use liquid-node as the default templating engine
  • New: a src/target structure for better planet source and target management
  • New: use feed.postSelector option to fetch full articles of the feed

Other changes:

  • Remove: cupid-server, because it is a bit unnecessary
  • Refactor: a much cleaner planet.json
  • Refactor: a much more robust and faster cupid-build