# gulp-header-git

> gulp plugin for adding headers containing information from git.

Latest version **0.5.0** (published 2017-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-header-git
pnpm add gulp-header-git
yarn add gulp-header-git
bun add gulp-header-git
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2017-12-28 |
| First published | 2015-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | brightSPARK Labs |
| Maintainers | brightsparklabs |
| Keywords | gulp, header, git |

## Links

- npm: https://www.npmjs.com/package/gulp-header-git
- Repository: https://github.com/brightsparklabs/gulp-header-git
- Homepage: https://github.com/brightsparklabs/gulp-header-git#readme
- Issues: https://github.com/brightsparklabs/gulp-header-git/issues
- npm.io page: https://npm.io/package/gulp-header-git

## Dependencies (4)

- [moment](https://npm.io/package/moment.md) ^2.10.6
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [sync-exec](https://npm.io/package/sync-exec.md) ^0.6.2
- [event-stream](https://npm.io/package/event-stream.md) ^3.3.2

## Recent versions

- 0.5.0 (latest) — 2017-12-28
- 0.4.0 — 2017-10-31
- 0.3.2 — 2017-02-02
- 0.3.1 — 2016-10-10
- 0.3.0 — 2016-08-19
- 0.2.0 — 2016-01-18
- 0.1.0 — 2015-12-10

## README

# gulp-header-git

`gulp` plugin for adding headers containing information from git.

Based off the excellent
[gulp-header](https://github.com/godaddy/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
# shell 
npm install gulp-header-git --save-dev 
```

# Usage

Within `gulpfile.js`:

```javascript 
// 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.

---
_Source: https://npm.io/package/gulp-header-git · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
