Ninety-nine Pitchers of Malt

    gulp-format-md

    2.0.0 • Public • Published

    gulp-format-md NPM version NPM monthly downloads NPM total downloads Linux Build Status

    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 ❤️ 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:

    Author

    Jon Schlinkert

    License

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


    This file was generated by verb-generate-readme, v0.8.0, on November 18, 2018.

    Install

    npm i gulp-format-md

    DownloadsWeekly Downloads

    1,168

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    9.58 kB

    Total Files

    8

    Last publish

    Collaborators

    • avatar