npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

gulp-remark

6.0.2 • Public • Published

gulp-remark

Build Coverage Downloads Chat Sponsors Backers

Gulp plugin for remark — markdown processor powered by plugins.

Installation

npm:

npm install --save-dev gulp-remark

Usage

var gulp = require('gulp')
var remark = require('remark-gulp')
var html = require('remark-html')
var lint = require('remark-preset-lint-markdown-style-guide')
 
gulp.task('default', function() {
  gulp
    .src('*.md')
    .pipe(
      remark()
        .use(html)
        .use(lint)
    )
    .pipe(gulp.dest('dist'))
})

API

remark([options])

Create a Gulp plugin. The files are processed with remark. This is similar to the remark-cli, so you can specify configuration with .remarkrc and ignore files with .remarkignore.

options

All options are passed to unified-engine-gulp. The parse and stringify settings can be passed in options.settings, or in configuration files (.remarkrc, package.json).

remark().use(plugin[, options])

Change the way remark works by using a plugin.

Contribute

See contributing.md in remarkjs/remark for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Denys Dovhan

install

npm i gulp-remark

Downloadsweekly downloads

32

version

6.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability