gulp-format-md

Gulp plugin for beautifying markdown using pretty-remarkable.

Install

Install with npm:

$ npm i gulp-format-md --save

Usage

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

Generate docs

Generate readme and API documentation with [verb][]:

$ npm i -d && npm run docs

Or, if [verb][] is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on February 15, 2016.