7.1 KiB
remark
unified processor to parse and serialize Markdown. Built on micromark. Powered by plugins. Part of the unified collective.
- API by unified
- Parses Markdown to a syntax tree with
remark-parse - mdast syntax tree
- Plugins transform the tree
- Serializes syntax trees to Markdown with
remark-stringify
Don’t need the parser? Or compiler? That’s OK: use unified directly.
Install
npm:
npm install remark
Use
See unified for more examples »
Common example
This example lints Markdown and turns it into HTML.
var remark = require('remark')
var recommended = require('remark-preset-lint-recommended')
var html = require('remark-html')
var report = require('vfile-reporter')
remark()
.use(recommended)
.use(html)
.process('## Hello world!', function (err, file) {
console.error(report(err || file))
console.log(String(file))
})
Yields:
1:1 warning Missing newline character at end of file final-newline remark-lint
⚠ 1 warning
<h2>Hello world!</h2>
Settings through data
This example prettifies Markdown and configures remark-stringify
through data.
var remark = require('remark')
remark()
.data('settings', {emphasis: '*', strong: '*'})
.process('_Emphasis_ and __importance__', function (err, file) {
if (err) throw err
console.log(String(file))
})
Yields:
*Emphasis* and **importance**
Settings through a preset
This example prettifies Markdown and configures remark-parse and
remark-stringify through a preset.
var remark = require('remark')
remark()
.use({settings: {emphasis: '*', strong: '*'}})
.process('_Emphasis_ and __importance__', function (err, file) {
if (err) throw err
console.log(String(file))
})
Yields:
*Emphasis* and **importance**
API
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? |
|||||||||