Markdown processor powered by plugins part of the @unifiedjs collective
remark is the world’s most popular Markdown parser! And it does so much more than parse: it inspects (check, lint) and transforms (generate, compile) Markdown too!
Everything is possible with plugins, such as checking Markdown code style (), transforming safely to React (
remark-react), adding a table of contents (
remark-toc), or compiling to man pages (
Internally, remark now uses micromark, a new, fast, and tiny CommonMark compliant Markdown tokenizer. It can be GFM compliant with
unifiedjs.comand peruse its Learn section for an overview
This repository contains the following packages:
remark-parse— Parse Markdown to syntax trees
remark-stringify— Serialize syntax trees to Markdown
remark— Programmatic interface with both
remark-cli— Command line interface wrapping
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
Use of remark plugins could also open you up to other attacks. Carefully assess each plugin and the risks involved in using them.
remarkjs/.githubfor ways to get started. See
support.mdfor ways to get help. Ideas for new plugins and tools can be posted in
remarkjs/ideas. Join us in Discussions to chat with the community and contributors.
A curated list of awesome 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!