README.md

Carpenter

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

Demo : Coffeekraken website carpenter

• Homepage: Coffeekraken
• Source: Github
• Twitter: Coffeekraken

Features

1. Build styleguide directly from your CSS codebase
   • Reflect perfectly what your website looks like
   • List all features that your CSS cover
   • Interactive demo
   • See the documentation
2. Aggregate markdown documentations
   • Tell Carpenter where to look for markdown files, it take care of displaying them nicely
   • Aggregate all the useful documentations in one interface
   • See the documentation
3. Document your twig/blade components
   • Compile your twig/blade templates
   • Support data files to compile your templates with
   • See the documentation

Install

npm install coffeekraken-carpenter --save-dev

Configure

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:

module.exports = {
	title: 'My Cool Website',
	styleguide: {
		files: [
			'dist/css/styleguide.css'
		]
	},
	documentation: {
		files: [
			'node_modules/coffeekraken-s-*/**/*.md',
			'README.md'
		]
	},
	components: {
		inject: [
			'dist/css/style.css',
			'dist/js/app.js'
		],
		viewsRootPath: 'app/views',
		phpBootstrapPath: 'app/bootstrap.php',
		saveCompiled: false
	}
}

Check out the full config file reference here

Launch

In order to launch Carpenter in your project, you just need to add this line in your package.json scripts:

{
	"scripts": {
		"carpenter": "coffeekraken-carpenter"
	}
}

Then launch Carpenter with

npm run carpenter

Documentation

• Configuration : All the configuration properties available
• Node API : Describe all the exposed Node API methods
• CLI : CLI options reference
• Displays : How to display your docblocks into the web interface
• Styleguide feature : How to use the styleguide feature
• Documentation feature : How to use the documentation feature
• Components feature : How to use the components feature

Browser support

IE / Edge	Firefox	Chrome	Safari
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.

License

The code is available under the MIT license.