Generate Hologram style guides with Gulp
Switch branches/tags
Nothing to show
Clone or download
rejahrehim Merge pull request #9 from ferrybig/patch-1
Fix the displaying of the title of the readme in github
Latest commit ba8848c Oct 20, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Adding files Jul 2, 2014
.jshintrc Adding files Jul 2, 2014
.npmignore Fixed bug - wrong config file path passed Oct 23, 2014
LICENSE Adding files Jul 2, 2014
README.md Fix the displaying of the title of the readme in github Oct 17, 2017
index.js added support to .yaml files May 11, 2017
package.json 1.2.3 May 12, 2017

README.md

gulp-hologram

NPM version Downloads

Generate Hologram style guides with gulp

Getting Started

This plugin requires gulp.

If you haven't used gulp before, be sure to check out the Getting Started guide, as it explains how to create a gulpfile as well as install and use gulp plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install gulp-hologram --save-dev

Once the plugin has been installed, it may be enabled inside your gulpfile with this line of JavaScript:

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

The "hologram" task

Overview

In your project's gulpfile, add a section named hologram . The path to your hologram config file as source.

gulp.task('hologram', function() {
        gulp.src('config.yml')
                .pipe(hologram());
});

Options

options.logging

Type: Boolean Set logging: true to enable Logging.

gulp.task('hologram', function() {
        gulp.src('config.yml')
                .pipe(hologram({logging:true}));
});

options.bundler

Type: 'Boolean' Set bundler: true to invoke hologram via bundler.

gulp.task('hologram', function() {
        gulp.src('config.yml')
                .pipe(hologram({bundler:true, logging:true}));
});

Contributing

Take care to maintain the existing coding style. gulp.

TO DO

-Add unit tests

Release History

  • 1.2.3 (Added .yaml file support)
  • 1.2.0 (Fixed Bugs)
  • 1.1.0 (Added support for Bundler)
  • 1.0.0 (First release)

License

Copyright (c) 2014 Rejah Rehim. Licensed under the MIT license.