No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
blog
dist
.gitignore
.npmignore
Brocfile.js
README.md
index.js
package.json
yarn.lock

README.md

Broccoli Blog API

npm version

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.