broccoli-styledown

Broccoli plugin for generating styleguide HTML with @peopledoc/Styledown

ℹ️ This package is forked from kmiyashiro/broccoli-styledown.

Installation

Add the github registry in your .npmrc for @peopledoc scoped package:

# Points to Github NPM registry
@peopledoc:registry=https://npm.pkg.github.com

Then you can install it:

npm install --save-dev @peopledoc/broccoli-styledown

Usage

var compileStyledown = require('@peopledoc/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

Contributors

KamiKillertO

kmiyashiro

ryuran

GreatWizard

MrChocolatine

lifeart

License

MIT