# gulp-format-md
> Gulp plugin for beautifying markdown using pretty-remarkable.
Latest version **2.0.0** (published 2018-11-18) · MIT license · 0 weekly downloads
## Install
```sh
npm install gulp-format-md
pnpm add gulp-format-md
yarn add gulp-format-md
bun add gulp-format-md
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-11-18 |
| First published | 2015-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | beautify, format, formatter, gulp, gulpplugin, markdown, md, plugin, prettify, pretty, remarkable |
## Links
- npm: https://www.npmjs.com/package/gulp-format-md
- Repository: https://github.com/jonschlinkert/gulp-format-md
- Issues: https://github.com/jonschlinkert/gulp-format-md/issues
- npm.io page: https://npm.io/package/gulp-format-md
## Dependencies (4)
- [sections](https://npm.io/package/sections.md) ^1.0.0
- [through2](https://npm.io/package/through2.md) ^2.0.3
- [remarkable](https://npm.io/package/remarkable.md) ^1.7.1
- [pretty-remarkable](https://npm.io/package/pretty-remarkable.md) ^1.0.0
## Alternatives
- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads
## Recent versions
- 2.0.0 (latest) — 2018-11-18
- 1.0.0 — 2017-07-01
- 0.1.12 — 2017-04-04
- 0.1.11 — 2016-09-27
- 0.1.10 — 2016-08-04
- 0.1.9 — 2016-04-23
- 0.1.8 — 2016-04-17
- 0.1.7 — 2016-02-16
- 0.1.6 — 2016-02-15
- 0.1.5 — 2016-01-08
- 0.1.4 — 2015-12-15
- 0.1.3 — 2015-12-15
- 0.1.2 — 2015-12-11
- 0.1.1 — 2015-12-11
- 0.1.0 — 2015-12-10
## README
# gulp-format-md [](https://www.npmjs.com/package/gulp-format-md) [](https://npmjs.org/package/gulp-format-md) [](https://npmjs.org/package/gulp-format-md) [](https://travis-ci.org/jonschlinkert/gulp-format-md)
> Gulp plugin for beautifying markdown using pretty-remarkable.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save gulp-format-md
```
See [release notes](#release-notes).
## Usage
```js
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**
```js
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](https://github.com/jonschlinkert) for updates.
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
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](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [markdown-toc](https://www.npmjs.com/package/markdown-toc): Generate a markdown TOC (table of contents) with Remarkable. | [homepage](https://github.com/jonschlinkert/markdown-toc "Generate a markdown TOC (table of contents) with Remarkable.")
* [pretty-remarkable](https://www.npmjs.com/package/pretty-remarkable): Plugin for prettifying markdown with Remarkable using custom renderer rules. | [homepage](https://github.com/jonschlinkert/pretty-remarkable "Plugin for prettifying markdown with Remarkable using custom renderer rules.")
* [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable "Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.")
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 18, 2018._
---
_Source: https://npm.io/package/gulp-format-md · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._