Install

npm install gulp-format-md

yarn add gulp-format-md

gulp-format-md

Gulp plugin for beautifying markdown using pretty-remarkable.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

 $ npm install --save gulp-format-md

See release notes.

Usage

 const gulp = require('gulp');
const format = require('gulp-format-md');

gulp.task('format', () => {
  return gulp.src('README.md')
    .pipe(format())
    .pipe(gulp.dest('.'));
});

Options

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', () => {
  return gulp.src('readme.md')
    .pipe(format({ newline: false }))
    .pipe(gulp.dest('.'));
});

Release Notes

v2.0

Removed

CLI was removed in v2.0. We will be releasing a standalone CLI soon, please watch the project or follow @jonschlinkert for updates.

About

Contributing

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

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

 $ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

 $ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | 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