Package Exports
- gulp-format-md
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-format-md) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gulp-format-md 
Gulp plugin for beautifying markdown using pretty-remarkable.
Install
Install with npm
$ npm i gulp-format-md --saveUsage
var gulp = require('gulp');
var format = require('gulp-format-md');
gulp.task('format-md', function () {
return gulp.src('readme.md')
.pipe(format())
.pipe(gulp.dest('.'));
});Options
force
Force gulp-format-md to format files with non-markdown extensions.
type: boolean
default: undefined
example
gulp.task('format-md', function () {
return gulp.src('foo.txt')
.pipe(format({force: true}))
.pipe(gulp.dest('.'));
});newline
gulp-format-md ensures that files have a trailing newline by default. Pass false to disable this and strip trailing whitespace.
type: boolean
default: true
example
gulp.task('format-md', function () {
return gulp.src('readme.md')
.pipe(format({newline: false}))
.pipe(gulp.dest('.'));
});Related projects
- gulp: The streaming build system | homepage
- pretty-remarkable: Plugin for prettifying markdown with Remarkable using custom renderer rules. | homepage
- remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage
Running tests
Install dev dependencies:
$ npm i -d && npm testContributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Author
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb on December 15, 2015.