npm install remark-stringify
var unified =var createStream =var html =var rehype2remark =var stringify =var processor =processstdin
processor to serialize mdast syntax trees to
Options can be passed directly, or passed later through
All the formatting options of
are supported and will be passed through.
Extending the compiler
remark-stringify will do its best to serialize markdown to match the syntax
tree, but there are several cases where that is impossible.
It’ll do its best, but complete roundtripping is impossible given that any
value could be injected into the tree.
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
parsing it again later can potentially be unsafe.
When parsing Markdown afterwards, 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.
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.
Support this effort and give back by sponsoring on OpenCollective!