Link Search Menu Expand Document

Remark

Plugins

Quickstart

var remark = require('remark')
var recommended = require('remark-preset-lint-recommended')
var html = require('remark-html')
var report = require('vfile-reporter')

remark()
  .use(recommended)
  .use(html)
  .process('## Hello world!', function(err, file) {
    console.error(report(err || file))
    console.log(String(file))
  })

Config

Types

Internal

  • Internally, remark now uses micromark, a new, fast, and tiny CommonMark compliant Markdown tokenizer. It can be GFM compliant with remark-gfm.

  • packages

    • remark-parse — Parse Markdown to syntax trees
    • remark-stringify — Serialize syntax trees to Markdown
    • remark — Programmatic interface with both remark-parse and remark-stringify
    • remark-cli — Command line interface wrapping remark

Table of contents