laravel-elixir-sassdoc

1.1.5 • Public • Published

laravel-elixir-sassdoc


Description

A laravel-elixir plugin for SASSDOC [http://sassdoc.com/] (http://sassdoc.com/)

Document you SASS / SCSS


Install

First, install laravel-elixir-sassdoc

$ npm install laravel-elixir-sassdoc --save-dev


Usage 1: Gulpfile

Call the plugin in gulpfile.js with:

    require('laravel-elixir-sassdoc');
    mix.sassdoc();

Options

mix.sassdoc(src, options);

src

src defaults to Laravel SASS path ('resources/assets/sass').

options

options should be passed through as an object {}. 'dest' is the only required option to run, SASSDOC. Leave blank to default to use default ('./storage/reports/sassdoc') or pass through a path as below

{ dest: './storage/reports/sassdoc' }

Usage 2: CLI

After configuring the elixir task, you can call SASSDOC directly from command line:

gulp sassdoc


TODOs

No TODOs


Changelog

  • 2016-03-25 v1.0 Initial release
  • 2016-05-10 v1.1 Allow CLI call

Package Sidebar

Install

npm i laravel-elixir-sassdoc

Weekly Downloads

2

Version

1.1.5

License

ISC

Last publish

Collaborators

  • impbob