Need help with remark?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

remarkjs
4.0K Stars 254 Forks MIT License 1.9K Commits 2 Opened issues

Description

Markdown processor powered by plugins part of the @unifiedjs collective

Services available

!
?

Need anything else?

Contributors list

remark

Build Coverage Downloads Size Sponsors Backers Chat

remark is a Markdown processor built on micromark powered by plugins part of the unified collective.

Intro

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 (

remark-lint
), transforming safely to React (
remark-react
)
, adding a table of contents (
remark-toc
)
, or compiling to man pages (
remark-man
)
.

Internally, remark now uses micromark, a new, fast, and tiny CommonMark compliant Markdown tokenizer. It can be GFM compliant with

remark-gfm
.

Finally, remark is part of the unified collective. Learn more about us:

Packages

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-parse
    and
    remark-stringify
  • remark-cli
    — Command line interface wrapping
    remark

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
. 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.

Sponsor

Support this effort and give back by sponsoring on OpenCollective!

Gatsby 🥇

Vercel 🥇

Netlify

Holloway

ThemeIsle

Boost Hub

Expo


You?

License

MIT © Titus Wormer

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.