Gulp plugins for Remark
Clone or download
Enter-tainer and wooorm Fix typo in example
Closes GH-35.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
Latest commit 9b9ca97 Dec 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig Refactor project Aug 13, 2018
.gitignore
.npmrc
.prettierignore Refactor project Aug 13, 2018
.travis.yml
index.js Refactor project Aug 13, 2018
license
package.json
readme.md
test.js Remove `event-stream` from tests Nov 26, 2018

readme.md

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('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 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