Have ideas to improve npm?Join in the discussion! ¬Ľ

    docpad-plugin-feedr

    2.14.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    Feedr Plugin for DocPad

    Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
    Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
    Slack community badge

    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 release 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?

    Patreon donate button Open Collective donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

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

    License

    Unless stated otherwise all works are:

    and licensed under:

    Install

    npm i docpad-plugin-feedr

    DownloadsWeekly Downloads

    16

    Version

    2.14.0

    License

    MIT

    Unpacked Size

    23.7 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar