DocPad
Contentful Plugin forImport Contentful entries into DocPad collections.
Inspired by and based on https://github.com/nfriedly/docpad-plugin-mongodb
Install
docpad install contentful
Configuration
Simple example
Add the following to your docpad configuration file:
plugins:contentful:collections:accessToken: "23e9e3d2eb2a2303d64262692..."spaceId: "sd0nae..."collectionName: "posts"relativeDirPath: "blog"extension: ".html"sort: date: 1 # newest firstmeta:layout: "blogpost"
Fancy example
plugins:contentful:collectionDefaults:accessToken: "23e9e3d2eb2a2303d64262692..."spaceId: "sd0nae..."collections:# accessToken and spaceId are imported from the defaultscollectionName: "posts"relativeDirPath: "blog"extension: '.html.eco'sort: date: 1 # newest first:documentsetMetalayout: 'default'tags: documentget'tags' or concat'post'data: """<%- @partial('post/'+@document.tumblr.type, @extend({}, @document, @document.tumblr)) %>"""collectionName: "comments"filters: content_type: "a content type id"extension: '.html.markup'sort: date: -1 #oldest firstmeta:write: falsespaceId: "some other space id"filters: content_type: "another content type id"collectionName: "stats"extension: ".json"
Config details:
Each configuration object in collections
inherits default values from collectionDefaults
and then from the built-in defaults:
accessToken: "accessToken" # the api key for the accessing the Contentful space spaceId: "spaceId" # the spaceId for the space in Contentful relativeDirPath: null # defaults to collectionName extension: ".json" injectDocumentHelper: null # function to format documents collectionName: "my-content" # name to give the collection, defaults to "contentful" sort: null # http://documentcloud.github.io/backbone/#Collection-comparator meta: # automatically added to each document filters: # optional Contentful query properties. "content_type" is usually the minimum required.
The default directory for where the imported documents will go inside is the collectionName.
You can override this using the relativeDirPath
plugin config option.
The default content for the imported documents is JSON data. You can can customise this with the injectDocumentHelper
plugin configuration option which is a function that takes in a single Document Model.
If you would like to render a template, add a layout, and change the extension, you can do it via the meta
configuration
option or you can get fancy and do this with (for example) the
eco and partials
plugins and following collection configuration:
extension: '.html.eco':documentsetMetalayout: 'default'tags: documentget'tags' or concat'post'data: """<%- @partial('post/'+@document.tumblr.type, @extend({}, @document, @document.tumblr)) %>"""
The sort
field is passed as the comparator to Query Engine which tries it as a
MongoDB-style sort first and then a
Backbone.js comparator second.
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:
Blog:
License
Unless stated otherwise all works are:
- Copyright © Mark Phillips
and licensed under:
- The incredibly permissive MIT License