laravel-elixir-style-guide v0.1.0

laravel-elixir-style-guide

Build style guide with Hologram and groo-theme.

Install

$ npm install laravel-elixir-style-guide --save-dev
$ bower install groot-theme --save

Usage

Create the hologram.yml in root path:

source: ./resources/assets/less
destination: ./docs/style-guide
documentation_assets: ./public/bower_components/groot-theme
dependencies:
  - ./public/images
css_include:
  - 'css/vendor.css'
  - 'css/main.css'
js_include:
  - 'js/vendor.js'
  - 'js/index.js'

Add document block in each style file, for example:

And create a index.md file in style folder (ex: resources/assets/less):

# Style Guide

... Description of style guide ...

Then invoke the styelGuide extension in your gulpfile.js:

var elixir = require('laravel-elixir');
require('laravel-elixir-style-guide');

elixir(function(mix) {
  mix.styleGuide();
});

Finally run gulp tasks:

gulp

Or rebuild style-guide only:

gulp style-guide

License

MIT