gulp-github-style-page

Converting markdown content with github-style-page.

Installation

npm install gulp gulp-github-style-page --save-dev

Quick Start

var gulp = require('gulp');
var githubStylePage = require('gulp-github-style-page');

gulp.task('taskName', function() {
    return gulp.src('path/to/README.md')
        .pipe(githubStylePage())
        .pipe(gulp.dest('dist'));
});

Customize template:

gulp.task('taskName2', function() {
    return gulp.src('path/to/README.md')
        .pipe(githubStylePage({
            customizeTemplatePath: 'path/to/customTemplate.html',
            vars: {
                t: 'awesome',
                v: '0.1.2'
            }
        }))
        .pipe(gulp.dest('dist'));
});

Use built-in template:

gulp.task('taskName3', function() {
    return gulp.src('path/to/README.md')
        .pipe(githubStylePage({
            template: 'project',
            vars: {
                pkg: {
                    name: 'awesome',
                    version: '0.1.0'
                },
                examples: ['simple', 'complex']
            }
        }))
        .pipe(gulp.dest('dist'));
});

Options

See github-style-page#options for detail.

Testing

npm test

License

MIT, see the LICENSE file for detail.