remark is not another Markdown to HTML compiler. It can generate and reformat Markdown too. Powered by plugins to do all kinds of things: check Markdown code style, transform safely to React, add a table of contents, or compile to man pages.
unifiedjs.comand try its guides for an overview
- Read unified’s readme for a technical intro
- Browse awesome remark to find out more about the ecosystem
- Follow us on Medium and Twitter to see what we’re up to
- Check out Contribute below to find out how to help out
This repository contains the following projects:
remark-parse— Parse Markdown documents to syntax trees
remark-stringify— Stringify syntax trees to Markdown documents
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 spectrum 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, organisation, or community you agree to abide by its terms.