gulp-header-git v0.5.0

gulp-header-git

gulp plugin for adding headers containing information from git.

Based off the excellent gulp-header.

Adds a Document Control header table to the beginning of markdown documents. Primarily used to include document metadata in files prior to export into PDFs via pandoc.

Installation

# shell 
npm install gulp-header-git --save-dev 

Usage

Within gulpfile.js:

// javascript

var header = require('gulp-header-git');

gulp.task('build', function() {
    gulp.src('src/markdown/**/*.md')
        .pipe(header()) 
        .pipe(gulp.dest('build/markdown'));
});

API

header(options)

options

Type: Object

options.asFooter

Type: boolean

Default: false

Set to true to place the Document Control table at the end of the document rather than at the beginning of the document.

options.includeTag

Type: boolean

Default: false

Set to true to include the output of git describe --dirty in the Version Identifier field.

Licenses

Refer to the LICENSE file for details.