remark-stringify

Compiler for unified. Serializes mdast syntax trees to Markdown. Used in the remark processor but can be used on its own as well. Can be extended to change how Markdown is serialized.

Install

npm:

npm install remark-stringify

Use

var unified = require('unified')
var createStream = require('unified-stream')
var html = require('rehype-parse')
var rehype2remark = require('rehype-remark')
var stringify = require('remark-stringify')

var processor = unified().use(html).use(rehype2remark).use(stringify, {
  bullet: '*',
  fence: '~',
  fences: true,
  incrementListMarker: false
})

process.stdin.pipe(createStream(processor)).pipe(process.stdout)

See unified for more examples »

API

See unified for API docs »

`processor().use(stringify[, options])`

Configure the processor to serialize mdast syntax trees to Markdown.

`options`

Options can be passed directly, or passed later through processor.data().

All the formatting options of mdast-util-to-markdown are supported and will be passed through.

Extending the compiler

See mdast-util-to-markdown. Then create a wrapper plugin such as remark-gfm.

Security

As Markdown is sometimes used for HTML, and improper use of HTML can open you up to a cross-site scripting (XSS) attack, use of remark can also be unsafe. When going to HTML, use remark in combination with the rehype ecosystem, and use rehype-sanitize to make the tree safe.

Use of remark plugins could also open you up to other attacks. Carefully assess each plugin and the risks involved in using them.

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help. Ideas for new plugins and tools can be posted in remarkjs/ideas.

A curated list of awesome remark resources can be found in awesome remark.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Sponsor

Support this effort and give back by sponsoring on OpenCollective!

Gatsby 🥇		Vercel 🥇		Netlify		Holloway	ThemeIsle	BoostIO	Expo
You?