JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 35740
  • Score
    100M100P100Q141892F
  • License MIT

Gulp plugin for beautifying markdown using pretty-remarkable.

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 NPM version NPM monthly downloads NPM total downloads Linux Build Status

Gulp plugin for beautifying markdown using pretty-remarkable.

Install

Install with npm:

$ npm install --save gulp-format-md

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('.'));
});

About

Contributing

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

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

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

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on July 01, 2017.