Powerful tool that provide a nice web interface to display your website styleguide and modules/plugins documentations in one place.
Carpenter is like a architect plan for your website
npm install coffeekraken-carpenter --save-dev
The configuration is made through the
carpenter.config.js file that you need to add at the root of your project.
Here's a simple example:
moduleexports =title : 'My Cool Website'styleguide :files :'dist/css/styleguide.css'documentation :files :'node_modules/coffeekraken-s-*/**/*.md''README.md'
styleguide.css file, you need to document your styleguide like so:
/*** @name My Cool Component* @styleguide Components / My Cool Component* @example html* <div class="my-cool-component">* Hello world* </div>*/
In order to launch Carpenter in your project, you just need to add this line in your
Then launch Carpenter with
npm run carpenter
IE / Edge
|IE11+||last 2 versions||last 2 versions||last 2 versions|
As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.
The code is available under the MIT license.