Git Product home page Git Product logo

gulp-fabricator's Introduction

gulp-dss

A plugin for Gulp to generate UI documentation with DSS Parser.

Basic Usage

var dss = require('gulp-dss');

gulp.task('dss', function() {
  return gulp.src('app/assets/stylesheets/**/*.{sass,scss}')
    .pipe(dss({
      output: 'index.html',
      templatePath: path.join(__dirname, 'templates')
    }))
    .pipe(gulp.dest('ui-docs/'));
});

Templates

The templatePath option points to the folder containing the templates.

You should create your own module.html and base.html, but there are some default ones provided.

The module.html template is rendered with the Generated Object from DSS.

The base.html template is rendered the content.

The template engine used is Nunjucks.

Roadmap

  • Write better readme
  • Provide better default templates that automatically include the stylesheets

gulp-fabricator's People

Contributors

ronanbrett avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.