Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nfriedly/docpad-plugin-cloudant
Cloudant importer for DocPad (Cloudant is a hosted couchdb service)
https://github.com/nfriedly/docpad-plugin-cloudant
Last synced: 17 days ago
JSON representation
Cloudant importer for DocPad (Cloudant is a hosted couchdb service)
- Host: GitHub
- URL: https://github.com/nfriedly/docpad-plugin-cloudant
- Owner: nfriedly
- Created: 2015-05-07T16:55:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-23T14:20:50.000Z (about 6 years ago)
- Last Synced: 2024-10-12T16:14:28.641Z (about 1 month ago)
- Language: CoffeeScript
- Size: 31.3 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[Cloudant](https://cloudant.com/) Importer Plugin for [DocPad](http://docpad.org)
[](https://travis-ci.org/nfriedly/docpad-plugin-cloudant)
[](https://npmjs.org/package/docpad-plugin-cloudant "View this project on NPM")
[](https://david-dm.org/nfriedly/docpad-plugin-cloudant)
[](https://david-dm.org/nfriedly/docpad-plugin-cloudant#info=devDependencies)
[](https://www.gittip.com/nfriedly/ "Donate weekly to this project using Gittip")
Import Cloudant collections into DocPad collections.
(Cloudant is a hosted [CouchDB](https://couchdb.apache.org/)-compatible database from IBM with a fairly generous free tier.)
Based on https://github.com/nfriedly/docpad-plugin-mongodb
## Install
```
docpad install cloudant
```
## Configuration
Add the following to your [docpad configuration file](http://docpad.org/docs/config):
``` coffee
plugins:
cloudant:
collections: [
cloudantConfig: {account: "foo", password: "bar"} // passed directly to the [node.js client](https://github.com/cloudant/nodejs-cloudant), so a `url` is also accepted
dbName: "posts"
collectionName: "blog_posts" # defaults to dbName
relativeDirPath: "blog" # defaults to dbName
extension: ".html" # defaults to .json
meta:
layout: "blogpost"
]
```
### 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 blog posts from the simple example above:
``` erb
Blog:
- <% for post in @getCollection('posts').toJSON(): %>
-
<%= post.title %>
<% end %>
```
### Using a view instead of fetching every document in the database
This allows you to limit and adjust the data in the cloundant database before downloading it to the docpad database.
``` coffee
plugins:
cloudant:
collections: [
cloudantConfig: {account: "foo", password: "bar"} // passed directly to the [node.js client](https://github.com/cloudant/nodejs-cloudant), so a `url` is also accepted
dbName: "posts"
collectionName: "my_view_collection"
viewDocument:
_id: "_design/my_design_document"
views:
my_view:
# the map function is sent to couchdb as a string.. but you can just wrap a regular function in parenthesis and call .toString() on it ;)
map: ((doc) ->
emit doc._id, doc
).toString()
alwaysReplaceViewDocument: false # When true, the existing view is deleted and recreated before fetching the documents. (This is handy when you're updating your view function.)
]
```
## MIT License
Copyright (c) 20154 Nathan Friedly - http://nfriedly.com/
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.