Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/morganconrad/metalsmith-get-contentful
A metalsmith plugin to read content from the Contentful API
https://github.com/morganconrad/metalsmith-get-contentful
contentful javascript metalsmith metalsmith-plugin
Last synced: 6 days ago
JSON representation
A metalsmith plugin to read content from the Contentful API
- Host: GitHub
- URL: https://github.com/morganconrad/metalsmith-get-contentful
- Owner: MorganConrad
- License: mit
- Created: 2017-11-04T23:15:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-11T04:05:15.000Z (about 1 year ago)
- Last Synced: 2024-04-26T08:41:40.440Z (9 months ago)
- Topics: contentful, javascript, metalsmith, metalsmith-plugin
- Language: JavaScript
- Size: 547 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://travis-ci.org/MorganConrad/metalsmith-get-contentful)
[](https://github.com/MorganConrad/metalsmith-get-contentful)
[](https://www.npmjs.org/package/metalsmith-get-contentful)
[](https://snyk.io/test/github/morganconrad/metalsmith-get-contentful)
[](https://coveralls.io/github/MorganConrad/metalsmith-get-contentful)
# metalsmith-get-contentful
A [Metalsmith](http://www.metalsmith.io/) plugin to read content from the Contentful API.
Lightweight wrapper around the [Contentful API](https://www.contentful.com/developers/docs/javascript/) to query content, get the content's fields, and place the fields into metalsmith "files" for later processing. Typically done before the markdown stage.
This plugin works best if your Contentful Content has fields that match up to the YAML data needed for your metalsmith template engine. For example, they should probably have a "title", "template", and, most importantly, "contents".
If your content has a mismatch, see `options.msFiles.addYAML` and `options.msFiles.postProcess()`.
### Usage
To grab all "projects", use their field "slug" as a filename, and put them under the path "/projects/{slug}.md"
```
var getContentful = require('../getContentful.js');
...
.use(getContentful({
client: {
space: '',
accessToken: ''
},
query : {
content_type: 'project'
},
msFiles : {
idField: 'slug',
filename: "projects/${id}.md"
}
}) )
```
### Options
#### client: **required** arg for [Contentful.createClient(client)](https://contentful.github.io/contentful.js/contentful/latest/contentful.html)
You must provide:
- accessToken:
- space:
#### query: arg for [client.getEntries(query)](https://contentful.github.io/contentful.js/contentful/latest/ContentfulClientAPI.html#.getEntries)
Default is {}.
#### msFiles: how to manipulate and place the content into metalsmith
- idField: field to use for id. default is 'slug'. falsy means use sys.id
- filename: pattern to create the metalsmith "filename" based on id. default is "posts/${id}.md"
- postProcess(): Default is null. If present, the content will be replaced by `postProcess(content)`. For example, if you need to rename fields.
- addYAML: default is {}. Gets added to each result. Useful if you want to add fields such as a template
- metadata: default is null. If present, also place all the data into metalsmith.metadata() here.
### Notes, Todos, and Caveats
If the "file" is already present, getContentful calls `done()` with an Error.
After writing this, discovered a very similar approach and code in [Bitbucket contentful-data](https://bitbucket.org/dmosemann/contentful-data)
A different approach is in [contentful-metalsmith](https://www.npmjs.com/package/contentful-metalsmith)
[leviwheatcroft/metalsmith-contentful](https://github.com/leviwheatcroft/metalsmith-contentful) also gave me a few ideas.