gulp-mdvars v2.0.0

gulp-mdvars

Parse VarStream metadatas in a markdown file and reemit the cleaned up markdown content with Gulp.

Usage

First, install gulp-mdvars as a development dependency:

npm install --save-dev gulp-mdvars

Then, add it to your gulpfile.js:

var mdvars = require('gulp-mdvars');
var marked = require('gulp-marked');

gulp.task('mdvars', function() {
  gulp.src(['assets/contents/*.md'])
    .pipe(mdvars({
      prop: 'metadata', // Datas will be set to the file object in the given property
     }))
    .pipe(marked()) // Do whatever you want with the cleaned up datas
    .pipe(gulp.dest('www/'));
});

gulp-mdvars is build on top of mdvars and varstream NPM modules. Please report specific issues in the corresponding repository.

API

mdvars(options)

options.prop

Type: String Default value: 'metadata'

A string value indicating in wich property metadatas must be filled.

Stats