https://github.com/sable-virt/gulp-frontnote

スタイルガイドジェネレーターFrontNoteのGulpプラグイン
https://github.com/sable-virt/gulp-frontnote

css frontnote gulp sass scss styleguide stylus

Last synced: 2 months ago
JSON representation

スタイルガイドジェネレーターFrontNoteのGulpプラグイン

• Host: GitHub
• URL: https://github.com/sable-virt/gulp-frontnote
• Owner: sable-virt
• License: mit
• Created: 2014-08-14T14:16:46.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-10-08T02:34:26.000Z (over 8 years ago)
• Last Synced: 2024-11-03T12:05:01.810Z (3 months ago)
• Topics: css, frontnote, gulp, sass, scss, styleguide, stylus
• Language: JavaScript
• Homepage:
• Size: 15.6 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-frontnote

> gulp-frontnote is [FrontNote](https://github.com/frontainer/frontnote) plugin for [gulp](https://github.com/wearefractal/gulp)

## Required

This plugin requires

* [gulp](https://github.com/wearefractal/gulp)

## Usage

First, install `gulp-frontnote` as a development dependency:

```shell

npm install --save-dev gulp-frontnote

```

Then, add it to your `gulpfile.js`:

```javascript

var frontNote = require('gulp-frontnote');

gulp.src('src/**/*.css')

	.pipe(frontNote({

		// options

	}));

```

## Options

Options supported by [frontnote](https://github.com/frontainer/frontnote)

## Usage Examples

```javascript

var frontNote = require('gulp-frontnote');

gulp.task('doc', function() {

	gulp.src('src/**/*.css')

		.pipe(frontNote({

			out: './doc',

			template: './my-template',

			overview: './overview.md',

			includePath: 'assets/**/*'

		}));

});

```