remark-parse

remark plugin to parse markdown

Usage no npm install needed!

<script type="module">
  import remarkParse from 'https://cdn.skypack.dev/remark-parse';
</script>

README

remark-parse

Build Coverage Downloads Size Sponsors Backers Chat

Parser for unified. Parses markdown to mdast syntax trees. Built on micromark and mdast-util-from-markdown. Used in the remark processor but can be used on its own as well. Can be extended to change how markdown is parsed.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install remark-parse

Use

import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkGfm from 'remark-gfm'
import remarkRehype from 'remark-rehype'
import rehypeStringify from 'rehype-stringify'

unified()
  .use(remarkParse)
  .use(remarkGfm)
  .use(remarkRehype)
  .use(rehypeStringify)
  .process('# Hi\n\n*Hello*, world!')
  .then((file) => {
    console.log(String(file))
  })

Yields:

<h1>Hi</h1>
<p><em>Hello</em>, world!</p>

See unified for more examples »

API

See unified for API docs »

This package exports no identifiers. The default export is remarkParse.

unified().use(remarkParse)

Configure the processor to read markdown as input and process mdast syntax trees.

Extending the parser

See micromark and mdast-util-from-markdown. Then create a wrapper plugin such as remark-gfm.

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.

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.

Sponsor

Support this effort and give back by sponsoring on OpenCollective!

Gatsby 🥇

Vercel 🥇

Netlify

Holloway

ThemeIsle

Boost Hub

Expo


You?

License

MIT © Titus Wormer