Skip to content

kmiyashiro/broccoli-styledown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

broccoli-styledown

Broccoli plugin for generating styleguide HTML with Styledown

This code is based heavily on broccoli-less-single

Installation

npm install --save-dev broccoli-styledown

Usage

var compileStyledown = require('broccoli-styledown');

var outputTree = compileStyledown([inputTrees], options)
  • inputTree: An array of nodes, ['styles', 'styleguide']. Only CSS-like files and your config MD file will be passed to Styledown.
  • options: Hash of options
    • configMd: (Default: config.md) Styledown config markdown file. Path relative to any inputNode. NOTE: If there are multiple config files with the same name in different inputNodes, bad things will probably happen.
    • destFile: File to output generated styleguide HTML in build directory.
    • styledown: A hash of options for Styledown.parse

Development

Tests

npm install
npm test

License

MIT

About

Broccoli plugin for generating styleguide HTML with Styledown

Resources

License

Stars

Watchers

Forks

Packages