PhilJ / gulp-kss

Gulp plugin for KSS (Knyle Style Sheets) documentation generation
50 stars 34 forks source link

How do you update the style-guide template? #6

Closed finteractive closed 10 years ago

finteractive commented 10 years ago

Thanks for creating this package!

I'd like to update the template the style guide is generated from. I'm moving from grunt to gulp and used to do the following (which may not have been the most efficient the first place)...

  1. Generated the site template in /styleguide-template after installing the node version of KSS
$ kss-node --init 
  1. Update the Grunt Task to use this new folder as a source.
  grunt.initConfig({

  styleguide: {

    options: {
      template: {
        src: 'styleguide-template'
      },

      framework: {
        name: 'kss'
      }
    },

    all: {
      files: [{
        'styleguide': 'sass/**/*.scss'
      }]
    }

  },

Could you tell what the gulp equivalent of "template: {src: 'styleguide-template} would be?

finteractive commented 10 years ago

Fixed it myself (sorry I realized today your docs included what I was looking for)

gulp.task('styleguide', function() {
  gulp.src(['sass/**/*.scss'])
      .pipe(gulpkss({
          overview: __dirname + '/sass/styleguide.md',
          templateDirectory: __dirname + '/styleguide-template'
      }))
    .pipe(gulp.dest('styleguide/'));
});