gulp-styleguide-generator

    0.0.1 • Public • Published

    gulp-styleguide-generator

    A small gulp plugin for generating styleguides.

    ✅ CSS or any preprocessors.

    ✅ EJS as template engine

    ✅ Simple and small

    ✅ Include custom variables

    ✅ Markdown

    Installation

    npm install gulp-styleguide-generator --save-dev

    Usage

    In your gulpfile.js:

    var gulp = require('gulp')
    var styleguide = require('gulp-styleguide-generator')
     
    gulp.task('styleguide', function () {
      return gulp.src('source/**/*.css')
        .pipe(styleguide({}))
    })

    Options

    var defaults = {
      templatePath: path.join(DIR, 'template'),
      outputPath: 'styleguide',
      vars: {
        template: 'template.html',
        output: null,
        css: ''
      }
    }

    Comments style

    Your comment should start with /**@docs. Here's an example:

    /**@docs
     
      You can override default variables:
      @template my-other-template-file.html
     
      Or just create new variables:
      @my-new-variable variable-value
     
      You can freely use markdown:
     
      ## My Component Name
     
      Description of my **component** here.
     
    */

    Keywords

    none

    Install

    npm i gulp-styleguide-generator

    DownloadsWeekly Downloads

    3

    Version

    0.0.1

    License

    none

    Last publish

    Collaborators

    • gsantiago