1.0.1 • Published 7 years ago

broccoli-blog-api v1.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

Broccoli Blog API

Warning this plugin is in very experimental early development and will probably change alot. If you have ideas or questions add an Issue to the Github Repository.

This Plugin will translate a directory (or set of directories) of Markdown documents into a static JSONAPI. The plugin parses front matter and turns it into other properties on the blog post resource.

Installation

To install this plugin run:

yarn add broccoli-blog-api

Use

To use this plugin, in your broccoli tree:

const BlogApi = require('broccoli-blog-api');

return new BlogApi('blogs');

Example

To better understand the inputs and outputs of this plugin, look at the Brocfile.js file, Blog Directory, and the Dist Output.