Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/gulp-format-md
Gulp plugin for beautifying markdown using pretty-remarkable.
https://github.com/jonschlinkert/gulp-format-md
beautify format formatter gulp gulp-plugin gulpplugin javascript jonschlinkert markdown markdown-toc node nodejs plugin prettify pretty remarkable
Last synced: 3 months ago
JSON representation
Gulp plugin for beautifying markdown using pretty-remarkable.
- Host: GitHub
- URL: https://github.com/jonschlinkert/gulp-format-md
- Owner: jonschlinkert
- License: mit
- Created: 2015-12-10T01:44:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-17T19:21:13.000Z (about 5 years ago)
- Last Synced: 2024-10-31T19:37:02.360Z (3 months ago)
- Topics: beautify, format, formatter, gulp, gulp-plugin, gulpplugin, javascript, jonschlinkert, markdown, markdown-toc, node, nodejs, plugin, prettify, pretty, remarkable
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 36.1 KB
- Stars: 9
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
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._