Contentful CMS plugin for spike
Note: This project is in early development, and versioning is a little different. Read this for more details.
If you're using Contentful and would like to pull your data for compilation into a spike static site, this will help you out.
npm install spike-contentful -S
This is a standard webpack plugin, but is built for and intended to be used with spike. You can include it in your spike project as such:
// app.js
const Contentful = require('spike-contentful')
const jade = require('posthtml-jade')
const locals = {}
module.exports = {
plugins: [
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx',
contentTypes: [
{
name: 'posts',
id: '633fTeiMaxxxxxxxxx',
},
{
name: 'authors',
id: '223gTahLaxxxxxxxxx',
}
]
})
],
posthtml: { plugins: jade(locals) }
}At a minimum, the spike-contentful plugin requires both name and id for contentTypes. The name corresponds with how you'd like to access it in your templates. The id is found listed under "Identifier" by logging into Contentful and clicking "APIs" then "Content model explorer".
Since Spike uses posthtml, you can use a variety of different plugins to expose local variables to your html. We are using jade here because it's the plugin provided in spike's default template, and also is currently the only plugin that provides the ability to run complex loops through objects.
In order to pass the data correctly, you must pass spike-contentful an object, which it will load the data onto when the compile begins under a contentful key. If you also pass the same object to whatever posthtml plugin you are using in whatever manner it requires to make the data available in your html templates, the data will be present on that object before they start compiling. This is a slightly unconventional pattern for Javascript libraries, but in this situation it allows for maximum flexibility and convenience.
Once included, it will expose a contentful local to your jade files, which you can use to iterate through your content types. Based on the example above, the posts content type will be accessible through contentful.posts, as such:
//- a jade file
ul
for post in contentful.posts
li= JSON.stringify(post)In some cases you'll need to use a content model to maintain order of another content model. Take the following for example:
Case Study
- Title [Short Text]
- Client [Short Text]
...
Case Study Order
- Case Studies [References, many]
In order to pull formatted and ordered case studies, you'll need to use the following parameters:
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx',
contentTypes: [
{
name: 'case_studies', // Arbitrary name used from within templates
id: '633fTeiMaxxxxxxxxx', // This should point to the case_studies_order content type
ordered: true // Required. Appropriately format the related ordered content type
}
]
})To limit the number of results for a given content type:
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx',
contentTypes: [
{
name: 'posts',
id: '633fTeiMaxxxxxxxxx',
filters: {
limit: 10
}
}
]
})Contentful returns a lot of associated data and, as a result, we clean that up by default. You also have the ability to pass your own custom transform option to each content type allowing you to transform the data however you like before it's sent to your views.
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx',
contentTypes: [
{
name: 'posts',
id: '633fTeiMaxxxxxxxxx',
transform: (post) => {
// do your transformation here...
return post
}
}
]
})You also have the ability to disable the default transform and receive the raw JSON data.
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx',
contentTypes: [
{
name: 'posts',
id: '633fTeiMaxxxxxxxxx',
transform: false
}
]
})Using the template option allows you to write objects returned from Contentful to single page templates. For example, if you are trying to render a blog as static, you might want each post returned from the API to be rendered as a single page by itself.
The template option is an object with path and output keys. The path is an absolute or relative path to a template to be used to render each item, and output is a function with the currently iterated item as a parameter, which should return a string representing a path relative to the project root where the single view should be rendered. For example:
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx'
contentTypes: [{
name: 'posts',
id: '633fTeiMaxxxxxxxxx',
template: : {
path: 'templates/post.html',
output: (post) => { return `posts/${post.id}.html` }
}
}]
})Your template must use the item variable as seen below. Note: you also will need to prevent Spike from attempting to render your template file normally by adding your templates to Spike's ignore option, or adding an underscore to the file name.
<p>{item.title}</p>Finally, if you'd like to have the output written locally to a JSON file so that it's cached locally, you can pass the name of the file, resolved relative to your project's output, as a json option to the plugin. For example:
new Contentful({
addDataTo: locals,
accessToken: 'xxx',
spaceId: 'xxx'
contentTypes: [{
name: 'posts',
id: '633fTeiMaxxxxxxxxx'
}],
json: 'data.json'
})If you'd like to use our default transform outside of the library, this is also available as an export. For example, you could include it and use it with client-side JS responses.
const Contentful = require('spike-contentful')
console.log(Contentful.transform)To run the tests locally, you'll need to add a test/.env with your name and token values:
cp test/.env.sample test/.envaccessTokenis derived from "APIs" > "Content Delivery API Keys" in the Contentful admin section.spaceIdis also derived from "APIs" > "Content Delivery API Keys" in the Contentful admin section.
- Details on the license can be found here
- Details on running tests and contributing can be found here