gulp-didor-styleguide v0.2.0

gulp-didor-styleguide

Genera una guía de estilos desde tu CSS, añadiendo comentarios en tu código.

Un plugin gulp para didor-styleguide.

Instalación

$ npm install gulp-didor-styleguide --save-dev

Como usarlo

var gulp = require('gulp'),
    styleguide = require('gulp-didor-styleguide');

gulp.task('styleguide', function() {
  gulp.src('./app/styles/main.scss')
    .pipe($.didorStyleguide(
      // Tus opciones aquí
    ));
});

API

didor-styleguide([opts])

Type: object Default: true

• logo (String): Logo que se mostrará en la barra lateral.
• css (String): Archivo css con los estilos compilados de la aplicación.
• outputFolder (String): Directorio donde se generará la guía de estilos.

El logo no es obligatorio, el resto de opciones están definidas por defecto para funcionar con Didor Starter Kit.

Ejemplo

gulp.task('styleguide', function() {
  gulp.src('./app/styles/main.scss')
    .pipe($.didorStyleguide({
      logo: './app/assets/images/logo.png',
      css: './.tmp/styles/main.css',
      outputFolder: './docs'
    }));
});

Ver también

• Didor Starter Kit
• Didor Styleguide
• Didor Framework