Gulp plugin for remark


Keywords
unified, remark, mdast, markdown, md, gulp, gulpplugin, gulp-plugins, remark-plugin
License
MIT
Install
npm install gulp-remark@7.0.0

Documentation

gulp-remark

Build Coverage Downloads Sponsors Backers Chat

Gulp plugin for remark — Markdown processor powered by plugins.

Install

npm:

npm install --save-dev gulp-remark

Use

var gulp = require('gulp')
var remark = require('gulp-remark')
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 (.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/.github for ways to get started. See support.md for ways to get help.

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

License

MIT © Denys Dovhan