Gulp plugin for beautifying markdown using pretty-remarkable.
npm install 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 with npm:
``sh`
$ npm install --save gulp-format-md
See release notes.
`js
const gulp = require('gulp');
const format = require('gulp-format-md');
gulp.task('format', () => {
return gulp.src('README.md')
.pipe(format())
.pipe(gulp.dest('.'));
});
`
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
`js`
gulp.task('format-md', () => {
return gulp.src('readme.md')
.pipe(format({ newline: false }))
.pipe(gulp.dest('.'));
});
Removed
CLI was removed in v2.0. We will be releasing a standalone CLI soon, please watch the project or follow @jonschlinkert for updates.
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:
`sh`
$ 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:
`sh``
$ npm install -g verbose/verb#dev verb-generate-readme && verb
You might also be interested in these projects:
* markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage with Remarkable.")
* 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
Jon Schlinkert
* GitHub Profile
* Twitter Profile
* LinkedIn Profile
Copyright © 2018, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.8.0, on November 18, 2018._