metalsmith-kss
A Metalsmith plugin to create KSS documentation.
Status
Installation
$ npm install metalsmith-kss
CLI Usage
Install via npm and then add the metalsmith-kss
key to your metalsmith.json
plugins, like so:
Javascript Usage
Pass options
to the kss plugin and pass it to Metalsmith with the use
method:
var kss = ; metalsmith;
External fixtures
KSS lacks the ability to include external fixtures in the markup section. Here is how to work around this: Say, you have an external HTML fixture in your site that you like to appear in the markup section of your KSS styleguide so you don't have to do updates twice.
- In your KSS, put the following in the according markup section:
//////////}
- In your metalsmith build file, add an object of all fixture files that you need to be available to KSS:
TODOs
- Allow other template engines
License
MIT