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
remark-lint), transforming safely to React
remark-react), adding a table of
remark-toc), or compiling to man pages
unifiedjs.comand peruse its Learn section for an overview
- Read unified’s readme for a technical intro
- Browse awesome remark to find out more about the ecosystem
- Follow us on Twitter to see what we’re up to
- Check out Contribute below to find out how to help out
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
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.
remarkjs/.github for ways
to get started.
support.md for ways to get help.
Ideas for new plugins and tools can be posted in
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!