ray-gulp-md
v1.1.1
Published
gulp md plugin
Downloads
11
Readme
ray-gulp-md
author
ilex.h
options
md2html options
/**
* 将 md 文件转化为 html
* @param {Object} options [marked.js](https://marked.js.org/#/USING_ADVANCED.md#options)
* @param {Object} cusMarked 自定义的marked
* @param {Boolean} single 是否补全 html 页面
*/
md2html(options, cusMarked, single = false)
md2js options
/**
* 将 md 文件转化为 js
* @param {Object} options [marked.js](https://marked.js.org/#/USING_ADVANCED.md#options)
* @param {Object} cusMarked 自定义的marked
*/
md2js(options, cusMarked)
usage
md2html
const gulp = require('gulp');
const md2html = require('ray-gulp-md/lib/md2html');
gulp.task('default', () => {
return gulp.src('readme.md')
.pipe(md2html())
.pipe(gulp.dest('dist'));
});
md2js
const gulp = require('gulp');
const md2js = require('ray-gulp-md/lib/md2js');
gulp.task('default', () => {
return gulp.src('readme.md')
.pipe(md2js())
.pipe(gulp.dest('dist'));
});
use pretty marked
const gulp = require('gulp');
const md2html = require('ray-gulp-md/lib/md2html');
const prettyMarked = require('ray-doc-render/lib/prettyMarked');
gulp.task('default', () => {
return gulp.src('readme.md')
.pipe(md2html({}, prettyMarked))
.pipe(gulp.dest('dist'));
});
License
MIT