{"id":15292112,"url":"https://github.com/jonschlinkert/gulp-format-md","last_synced_at":"2026-02-26T02:12:58.400Z","repository":{"id":57257625,"uuid":"47730574","full_name":"jonschlinkert/gulp-format-md","owner":"jonschlinkert","description":"Gulp plugin for beautifying markdown using pretty-remarkable.","archived":false,"fork":false,"pushed_at":"2019-12-17T19:21:13.000Z","size":37,"stargazers_count":9,"open_issues_count":3,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T01:51:33.572Z","etag":null,"topics":["beautify","format","formatter","gulp","gulp-plugin","gulpplugin","javascript","jonschlinkert","markdown","markdown-toc","node","nodejs","plugin","prettify","pretty","remarkable"],"latest_commit_sha":null,"homepage":"https://github.com/jonschlinkert","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonschlinkert.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-10T01:44:35.000Z","updated_at":"2021-04-12T22:19:50.000Z","dependencies_parsed_at":"2022-08-25T19:10:37.178Z","dependency_job_id":null,"html_url":"https://github.com/jonschlinkert/gulp-format-md","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fgulp-format-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fgulp-format-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fgulp-format-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fgulp-format-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonschlinkert","download_url":"https://codeload.github.com/jonschlinkert/gulp-format-md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248698877,"owners_count":21147545,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beautify","format","formatter","gulp","gulp-plugin","gulpplugin","javascript","jonschlinkert","markdown","markdown-toc","node","nodejs","plugin","prettify","pretty","remarkable"],"created_at":"2024-09-30T16:16:35.243Z","updated_at":"2026-02-26T02:12:53.367Z","avatar_url":"https://github.com/jonschlinkert.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulp-format-md [![NPM version](https://img.shields.io/npm/v/gulp-format-md.svg?style=flat)](https://www.npmjs.com/package/gulp-format-md) [![NPM monthly downloads](https://img.shields.io/npm/dm/gulp-format-md.svg?style=flat)](https://npmjs.org/package/gulp-format-md) [![NPM total downloads](https://img.shields.io/npm/dt/gulp-format-md.svg?style=flat)](https://npmjs.org/package/gulp-format-md) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/gulp-format-md.svg?style=flat\u0026label=Travis)](https://travis-ci.org/jonschlinkert/gulp-format-md)\n\n\u003e Gulp plugin for beautifying markdown using pretty-remarkable.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save gulp-format-md\n```\n\nSee [release notes](#release-notes).\n\n## Usage\n\n```js\nconst gulp = require('gulp');\nconst format = require('gulp-format-md');\n\ngulp.task('format', () =\u003e {\n  return gulp.src('README.md')\n    .pipe(format())\n    .pipe(gulp.dest('.'));\n});\n```\n\n## Options\n\n### newline\n\n`gulp-format-md` ensures that files have a trailing newline by default. Pass `false` to disable this and strip trailing whitespace.\n\n**type**: `boolean`\n\n**default**: `true`\n\n**example**\n\n```js\ngulp.task('format-md', () =\u003e {\n  return gulp.src('readme.md')\n    .pipe(format({ newline: false }))\n    .pipe(gulp.dest('.'));\n});\n```\n\n## Release Notes\n\n### v2.0\n\n**Removed**\n\nCLI 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.\n\n## About\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eContributing\u003c/strong\u003e\u003c/summary\u003e\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eRunning Tests\u003c/strong\u003e\u003c/summary\u003e\n\nRunning 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:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eBuilding docs\u003c/strong\u003e\u003c/summary\u003e\n\n_(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.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme \u0026\u0026 verb\n```\n\n\u003c/details\u003e\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [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.\")\n* [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.\")\n* [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.\")\n\n### Author\n\n**Jon Schlinkert**\n\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 18, 2018._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Fgulp-format-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonschlinkert%2Fgulp-format-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Fgulp-format-md/lists"}