{"id":15503060,"url":"https://github.com/johno/gulp-remarkable","last_synced_at":"2025-04-22T23:21:15.804Z","repository":{"id":22461955,"uuid":"25800635","full_name":"johno/gulp-remarkable","owner":"johno","description":"A gulp wrapper for the remarkable markdown parser (CommonMark spec).","archived":false,"fork":false,"pushed_at":"2018-07-12T21:13:05.000Z","size":32,"stargazers_count":10,"open_issues_count":7,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-19T17:31:00.611Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/johno.png","metadata":{"files":{"readme":"readme.md","changelog":"history.md","contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-27T02:53:26.000Z","updated_at":"2020-09-24T22:38:19.000Z","dependencies_parsed_at":"2022-08-21T05:00:58.018Z","dependency_job_id":null,"html_url":"https://github.com/johno/gulp-remarkable","commit_stats":null,"previous_names":["johnotander/gulp-remarkable"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fgulp-remarkable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fgulp-remarkable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fgulp-remarkable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johno%2Fgulp-remarkable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johno","download_url":"https://codeload.github.com/johno/gulp-remarkable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250338488,"owners_count":21414196,"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":[],"created_at":"2024-10-02T09:12:02.035Z","updated_at":"2025-04-22T23:21:15.785Z","avatar_url":"https://github.com/johno.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gulp Remarkable [![NPM version][npmjs-shields]][npmjs-url] [![Build Status][travis-img]][travis-url] [![Dependency Status][depstat-img]][depstat-url]\n\nA [gulp](http://gulpjs.com) plugin for [Remarkable][remarkable-url] - Markdown parser, done right.\nFast and easy to extend. Supports [CommonMark][commonmark-url].\n\n## Installation\n\nInstall using [npm](https://npmjs.org):\n\n```\n$ npm install gulp-remarkable\n```\n\nSee [gulp-remarkable on npm][npmjs-url].\n\n\n## Options\n\n- `remarkableOptions` **{Object}** Options to be passed to Remarkable\n- `disable` **[Array]** Options to be passed to `md.core.ruler.disable`\n  + to use it, first `remarkableOptions.typographer` must be set to `true`\n- `preset` **{String}** Remarkable's preset, default `full`\n\n\n## Usage\n\n**Default Example**\n```js\nvar gulp = require('gulp'),\n    name = require('gulp-rename'),\n    md   = require('gulp-remarkable');\n\ngulp.task('md', function() {\n  return gulp.src('file.md')\n    .pipe(md({preset: 'commonmark'}))\n    .pipe(name('file.html'))\n    .pipe(gulp.dest('dist'));\n});\n\ngulp.task('default', ['md']);\n```\n\n**Extended Example**\n```js\nvar gulp = require('gulp'),\n    name = require('gulp-rename'),\n    md   = require('gulp-remarkable');\n\ngulp.task('md', function() {\n  return gulp.src('file.md')\n    .pipe(md({\n      preset: 'full',\n      disable: ['replacements'],\n      remarkableOptions: {\n        typographer: true,\n        linkify: true,\n        breaks: true\n      }\n    }))\n    .pipe(name('file.html'))\n    .pipe(gulp.dest('dist'));\n});\n\ngulp.task('default', ['md']);\n```\n\n**Using Plugins**\n\ngulp-remarkable accepts one or two parameters: options and an optional function that accepts gulpRemarkable object.\n\n```js\nvar gulp = require('gulp')\nvar md = require('gulp-remarkable')\n\nreturn gulp.src(globMarkdown)\n    .pipe(md(opts, (m=\u003e{\n      m.renderer.rules.heading_open = headingAnchorRendererPlugin\n    })))\n\nfunction headingAnchorRendererPlugin(tokens, idx ) {\n  if (tokens[idx+1].type == 'inline') {\n    let heading_anchor = slug(tokens[idx+1].content, {lower: true})\n    return '\u003ch' + tokens[idx].hLevel + ' id=\"' + heading_anchor + '\"\u003e';\n  }\n  return '\u003ch' + tokens[idx].hLevel + '\u003e';\n}\n```\n\n## Run tests\n\n```\n$ npm test\n```\n\n\n## Authors \u0026 Contributors\n\n**John Otander**\n+ [github/johnotander][author-github]\n+ [twitter/4lpine][author-twitter]\n+ [npmjs/johno][author-npmjs]\n+ [more ...][author-more]\n\n**Charlike Mike Reagent** [![author tips][author2-gittip-img]][author2-gittip]\n+ [gittip/tunnckoCore][author2-gittip]\n+ [github/tunnckoCore][author2-github]\n+ [twitter/tunnckoCore][author2-twitter]\n+ [npmjs/tunnckoCore][author2-npmjs]\n+ [more ...][author2-more]\n\n**Evans Jahja**\n+ [github/Charon77][contrib-github]\n\n## License [![MIT license][license-img]][license-url]\n\nCopyright (c) 2014 [John Otander][author-website], [contributors](https://github.com/johnotander/gulp-remarkable/graphs/contributors).  \nReleased under the [`MIT`][license-url] license.\n\n\n## Acknowledgements\n\n* Markdown parsing done by remarkable: \u003chttps://github.com/jonschlinkert/remarkable\u003e\n* Markdown spec defined by CommonMark: \u003chttp://commonmark.org\u003e\n* Test script adapted from: \u003chttps://github.com/sindresorhus/gulp-markdown/blob/master/test.js\u003e\n\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n\n\n[downloads-img]: http://img.shields.io/npm/dm/gulp-remarkable.svg\n[npm-required-version-img]: http://img.shields.io/badge/npm-%3E=%201.4.28-blue.svg\n[node-required-version-img]: https://img.shields.io/node/v/gulp-remarkable.svg\n[node-required-version-url]: http://nodejs.org/download/\n\n[npmjs-url]: http://npm.im/gulp-remarkable\n[npmjs-fury]: https://badge.fury.io/js/gulp-remarkable.svg\n[npmjs-shields]: https://img.shields.io/npm/v/gulp-remarkable.svg\n[npmjs-install]: https://nodei.co/npm/gulp-remarkable.svg?mini=true\n\n[coveralls-url]: https://coveralls.io/r/johnotander/gulp-remarkable?branch=master\n[coveralls-shields]: https://img.shields.io/coveralls/johnotander/gulp-remarkable.svg\n\n[license-url]: https://github.com/johnotander/gulp-remarkable/blob/master/license.md\n[license-img]: http://img.shields.io/badge/license-MIT-blue.svg\n\n[travis-url]: https://travis-ci.org/johnotander/gulp-remarkable\n[travis-img]: https://travis-ci.org/johnotander/gulp-remarkable.svg?branch=master\n\n[depstat-url]: https://david-dm.org/johnotander/gulp-remarkable\n[depstat-img]: https://david-dm.org/johnotander/gulp-remarkable.svg\n\n[ferver-img]: http://img.shields.io/badge/using-ferver-585858.svg\n[ferver-url]: https://github.com/jonathanong/ferver\n\n[author-github]: https://github.com/johnotander\n[author-twitter]: https://twitter.com/4lpine\n[author-website]: http://johnotander.com\n[author-npmjs]: https://npmjs.org/~johno\n[author-more]: http://johnotander.com\n\n[author2-gittip-img]: http://img.shields.io/gittip/tunnckoCore.svg\n[author2-gittip]: https://www.gittip.com/tunnckoCore\n[author2-github]: https://github.com/tunnckoCore\n[author2-twitter]: https://twitter.com/tunnckoCore\n[author2-website]: http://www.whistle-bg.tk\n[author2-npmjs]: https://npmjs.org/~tunnckocore\n[author2-more]: http://j.mp/1stW47C\n\n[contrib-github]: https://github.com/Charon77\n\n[cobody-url]: https://github.com/tj/co-body\n[mocha-url]: https://github.com/tj/mocha\n[rawbody-url]: https://github.com/stream-utils/raw-body\n[multer-url]: https://github.com/expressjs/multer\n[express-url]: https://github.com/strongloop/express\n[formidable-url]: https://github.com/felixge/node-formidable\n[co-url]: https://github.com/tj/co\n[extend-url]: https://github.com/justmoon/node-extend\n[csp-report]: https://mathiasbynens.be/notes/csp-reports\n[remarkable-url]: https://github.com/jonschlinkert/remarkable\n[commonmark-url]: http://commonmark.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohno%2Fgulp-remarkable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohno%2Fgulp-remarkable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohno%2Fgulp-remarkable/lists"}