Extract front-matter header from files


Keywords
gulpplugin, yml, yaml, parse, data, property, extract, attribute, attributes, frontmatter, front-matter, meta, metadata, meta-data
License
BSD-2-Clause
Install
npm install gulp-front-matter@2.0.0-7

Documentation

gulp-front-matter

npm version Build Status Coverage Status

Information

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

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