jekyll-evernote_rss

Synopsis

This is a small Jekyll plugin for integrating a public Evernote notebook into your blog via RSS. The code's not pretty yet, but functional.

Kudos to Christian Hellsten for code inspiration.

Requirements

Paul Dix's feedzirra gem
gem install feedzirra or add it to your Jekyll blog's Gemfile and run bundle

Usage

Simply integrate the evernote_rss tag into the desired page and define the following attributes:

Mandatory attributes:
- username: String - Your Evernote username, e.g. johndoe
- notebook: String - The public notebook's name, e.g. articles
Optional attributes:
- count: Integer - Defines how many articles will be displayed, default is 10

Here's a twitter bootstrap backed example with a table structure:

<table class="table table-striped">
  <thead>
    <th>Title</th>
    <th>Date</th>
  </thead>
  <tbody>
    {% evernote_rss username:fooforge notebook:public count:20 %}
      <tr>
        <td><a href='{{ item.url }}'>{{ item.title }}</a></td>
        <td>{{ item.published }}</td>
      </tr>
    {% endevernote_rss %}
  </tbody>
</table>

The RSS feed provides the following items:

{{ item.url }} - A note's URL
{{ item.title }} - The note's title
{{ item.published }} - Date of publication
{{ item.summary }} - Preview of the note's content

Please note that the content only gets updated when you regenerate your Jekyll blog. You might wanna setup a cron job or (better) use a provisioning tool like Chef to keep things updated at regular intervals.

I've also written a simple chef cookbook that'll deploy your Jekyll blog.

A working example can be seen on fooforge.com.

Known bugs

Direct links in Safari

When trying to access a specific article in Safari you'll get redirected to the public notebook's home URL. Told Evernote about it, hopefully they'll get this fixed soon.

Development

Source hosted at GitHub
Report issues/Questions/Feature requests on GitHub as well

Pull requests are very welcome! Make sure your patches are well tested.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fooforge / jekyll-evernote_rss Goto Github PK