6.1 KiB
remark-parse
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
npm:
npm install remark-parse
Use
var unified = require('unified')
var createStream = require('unified-stream')
var markdown = require('remark-parse')
var remark2rehype = require('remark-rehype')
var html = require('rehype-stringify')
var processor = unified().use(markdown).use(remark2rehype).use(html)
process.stdin.pipe(createStream(processor)).pipe(process.stdout)
See unified for more examples »
API
processor().use(parse)
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? |
|||||||||