Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/docpad-archive/docpad-plugin-tumblr
Imports Tumblr data into your DocPad Database
https://github.com/docpad-archive/docpad-plugin-tumblr
docpad-plugin unsupported
Last synced: 2 days ago
JSON representation
Imports Tumblr data into your DocPad Database
- Host: GitHub
- URL: https://github.com/docpad-archive/docpad-plugin-tumblr
- Owner: docpad-archive
- License: other
- Created: 2013-01-25T15:17:38.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2015-09-05T03:43:27.000Z (about 9 years ago)
- Last Synced: 2024-09-17T20:49:54.768Z (about 2 months ago)
- Topics: docpad-plugin, unsupported
- Language: CoffeeScript
- Homepage:
- Size: 251 KB
- Stars: 9
- Watchers: 18
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Tumblr](https://www.tumblr.com/) Importer Plugin for [DocPad](http://docpad.org)
[](http://travis-ci.org/docpad/docpad-plugin-tumblr "Check this project's build status on TravisCI")
[](https://npmjs.org/package/docpad-plugin-tumblr "View this project on NPM")
[](https://david-dm.org/docpad/docpad-plugin-tumblr)
[](https://david-dm.org/docpad/docpad-plugin-tumblr#info=devDependencies)
[](https://www.gittip.com/docpad/ "Donate weekly to this project using Gittip")
[](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")
[](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")
[](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")
Import your Tumblr content directly into your DocPad database
## Install
```
docpad install tumblr
```
## Configuration
### Specifying your Blog
You need to specify `TUMBLR_BLOG` (e.g. `balupton.tumblr.com`) and your `TUMBLR_KEY` in either your [`.env` configuration file](http://docpad.org/docs/config#environment-configuration-file) like so:
```
TUMBLR_BLOG=balupton.tumblr.com
TUMBLR_API_KEY=123
```
Or via your [docpad configuration file](http://docpad.org/docs/config) via:
``` coffee
plugins:
tumblr:
blog: 'balupton.tumblr.com'
apiKey: '123'
```
You can [create a new Tumblr API KEY here](http://www.tumblr.com/oauth/register) or [find your exiting ones here](http://www.tumblr.com/oauth/apps). Your API KEY is the same as your OAuth Consumer Key.
### Customising the Output
The default directory for where the imported documents will go inside is the `tumblr` directory. You can customise this using the `relativeDirPath` plugin configuration option.
The default extension for imported documents is `.json`. You can customise this with the `extension` plugin configuration option.
The default content for the imported documents is the serialised tumblr data as JSON data. You can can customise this with the `injectDocumentHelper` plugin configuration option which is a function that takes in a single [Document Model](https://github.com/bevry/docpad/blob/master/src/lib/models/document.coffee).
If you would like to render a partial for the tumblr data type, add a layout, and change the extension, you can this with the following plugin configuration:
``` coffee
extension: '.html.eco'
injectDocumentHelper: (document) ->
document.setMeta(
layout: 'default'
tags: (document.get('tags') or []).concat(['post'])
data: """
<%- @partial('post/'[email protected], @extend({}, @document, @document.tumblr)) %>
"""
)
```
You can find a great example of this customisation within the [syte skeleton](https://github.com/docpad/syte.docpad) which combines the tumblr plugin with the [partials plugin](http://docpad.org/plugin/partials) as well as the [tags plugin](http://docpad.org/plugin/tags) and [paged plugin](http://docpad.org/plugin/paged).
### Creating a File Listing
As imported documents are just like normal documents, you can also list them just as you would other documents. Here is an example of a `index.html.eco` file that would output the titles and links to all the imported tumblr documents:
``` erb
Tumblr:
- <% for file in @getFilesAtPath('tumblr/').toJSON(): %>
-
<%= file.title %>
<% end %>
```
## History
[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/docpad/docpad-plugin-tumblr/blob/master/HISTORY.md#files)
## Contribute
[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/docpad/docpad-plugin-tumblr/blob/master/CONTRIBUTING.md#files)
## Backers
### Maintainers
These amazing people are maintaining this project:
- Benjamin Lupton (https://github.com/balupton)
### Sponsors
No sponsors yet! Will you be the first?
[](https://www.gittip.com/docpad/ "Donate weekly to this project using Gittip")
[](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")
[](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")
[](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")
### Contributors
These amazing people have contributed code to this project:
- [Benjamin Lupton](https://github.com/balupton) — [view contributions](https://github.com/docpad/docpad-plugin-tumblr/commits?author=balupton)
[Become a contributor!](https://github.com/docpad/docpad-plugin-tumblr/blob/master/CONTRIBUTING.md#files)
## License
Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)
Copyright © Bevry Pty Ltd (http://bevry.me)