Skip to content

rtablada/broccoli-blog-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published