Home

Awesome

gulp-front-matter

npm version Build Status Coverage Status

Information

<table> <tr> <td>Package</td><td>gulp-front-matter</td> </tr> <tr> <td>Description</td> <td>Extract `YAML Front-Matter` header from files, removes it from `contents` and add a new `frontMatter` property to file object.</td> </tr> <tr> <td>Node Version</td> <td>≥ 4</td> </tr> </table>

Installation

Use npm.

npm install gulp-front-matter

Usage

const gulp = require('gulp');
const frontMatter = require('gulp-front-matter');

gulp.task('blog-posts', () => {
  return gulp.src('./posts/*.md')
    .pipe(frontMatter({ // optional configuration
      property: 'frontMatter', // property added to file object
                               // also works with deep property selectors
                               // e.g., 'data.foo.bar'
      remove: true // should we remove front-matter header?
    }))
    .pipe(…) // you may want to take a look at gulp-marked at this point
});

LICENSE

2-Clause BSD License © 2013 - 2015 Nicolas Chambrier, 2016 - 2017 Shinnosuke Watanabe