Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Adds support for reading feeds to DocPad
CoffeeScript HTML
Failed to load latest commit information.
src v2.10.0 August 8, 2014
test v2.10.0 August 8, 2014
.editorconfig v2.9.0 August 8, 2014
.gitignore updated base files
.jshintrc
.npmignore updated base files
.travis.yml updated base files
CONTRIBUTING.md updated base files
Cakefile updated base files
HISTORY.md v2.11.0. Updated deps.
LICENSE.md updated base files
README.md updated base files
coffeelint.json v2.9.0 August 8, 2014
package.json v2.11.0. Updated deps.

README.md

Feedr Plugin for DocPad

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

This plugin is able to pull in remote json and xml feeds, convert them to JSON data, and expose them to @feedr.feeds[feedName] for your templates, via the Feedr module.

Install

docpad install feedr

Usage

Setup

First we have to tell Feedr which feeds it should retrieve, you can do this by adding the following to your website's docpad configuration file:

plugins:
    feedr:
        feeds:
            twitter:
                url: "https://api.twitter.com/1/statuses/user_timeline.json?screen_name=balupton&count=20&include_entities=true&include_rts=true"

            someOtherFeedName:
                url: "someOtherFeedUrl"

Feedr can also clean up responses like "key": {"_content": "the actual value"} (as used on Flickr) to the cleaner "key": 'the actual value". To enable this set clean to true inside your feed configuration like so:

flickrUser:
    url: "http://api.flickr.com/services/rest/?method=flickr.people.getInfo&api_key=#{FLICKR_API_KEY}&user_id=#{FLICKR_USER_ID}&format=json&nojsoncallback=1"
    clean: true

Rendering

Then inside your templates, we would do something like the following to render the items:

  • Using Eco

    <ul>
        <% for tweet in @feedr.feeds.twitter: %>
            <% continue  if tweet.in_reply_to_user_id %>
            <li datetime="<%=tweet.created_at%>">
                <a href="https://twitter.com/#!/<%=tweet.user.screen_name%>/status/<%=tweet.id_str%>" title="View on Twitter">
                    <%=tweet.text%>
                </a>
            </li>
        <% end %>
    </ul>
  • Using CoffeeKup

    ul ->
        for tweet in @feedr.feeds.twitter
            continue  if tweet.in_reply_to_user_id
            li datetime: tweet.created_at, ->
                a href: "https://twitter.com/#!/#{tweet.user.screen_name}/status/#{tweet.id_str}", title: "View on Twitter", ->
                    tweet.text

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Unless stated otherwise all works are:

and licensed under:

Something went wrong with that request. Please try again.