small commonmark compliant markdown parser with positional info and concrete tokens
Micromark is a powerful, low-level Markdown parser and compiler. It allows for parsing Markdown content into abstract syntax trees (ASTs), manipulating those trees, and then compiling them back into Markdown or HTML. It's designed for flexibility, extensibility, and adherence to the CommonMark specification, making it suitable for a wide range of applications where Markdown processing is required.
Parsing Markdown to HTML
This feature allows you to convert Markdown text into HTML. The code sample demonstrates how to parse a simple Markdown heading into its HTML equivalent.
const micromark = require('micromark');
const html = micromark('# Hello World');
console.log(html);Extensibility with Syntax Extensions
Micromark can be extended with additional syntax features not covered by the CommonMark specification. This example shows how to use the GitHub Flavored Markdown (GFM) extension to parse text with GFM-specific features.
const micromark = require('micromark');
const gfm = require('micromark-extension-gfm');
const html = micromark('Hello, world!', {extensions: [gfm()]});
console.log(html);Custom HTML Renderers
This feature allows for custom HTML rendering of Markdown elements. The code sample demonstrates how to customize the rendering of images by adding a custom CSS class to the <img> tag.
const micromark = require('micromark');
const html = micromark('', {
htmlExtensions: [{
enter: {image: (node) => `<img src="${node.url}" alt="${node.alt}" class="custom-class">`}
}]
});
console.log(html);Marked is a fast Markdown parser and compiler built for speed. It is simpler and less customizable than micromark but offers a good balance between speed and extensibility for many common use cases.
Remark is part of the unified collective and provides a powerful Markdown processor powered by plugins. It focuses on the manipulation of Markdown and ASTs, similar to micromark, but with a higher-level API and a broader ecosystem of plugins for extended functionality.
Showdown is a JavaScript Markdown to HTML converter, which can be used both on the client side and server side. It is designed to be easy to use and extend, similar to micromark, but with a focus on simplicity and ease of integration into existing projects.
Small CommonMark compliant markdown parser with positional info and concrete tokens.
micromark is a long awaited markdown parser.
It uses a state machine to parse the entirety of markdown into tokens.
It’s the smallest 100% CommonMark compliant markdown parser in JavaScript.
It’ll replace the internals of remark-parse, the most
popular markdown parser.
Its interface is optimized to compile to HTML, but its parts can be used
to generate syntax trees or compile to other output formats too.
It’s in open beta: integration in remark, performance, CSTs, and docs.
unifiedjs.commdast-util-from-markdown,
mdast-util-to-markdown)npm:
npm install micromark
var micromark = require('micromark')
console.log(micromark('## Hello, *world*!'))
Yields:
<h2>Hello, <em>world</em>!</h2>
Or (streaming interface):
var fs = require('fs')
var micromark = require('micromark/stream')
fs.createReadStream('example.md').pipe(micromark()).pipe(process.stdout)
Or (extensions, in this case micromark-extension-gfm):
var micromark = require('micromark')
var gfmSyntax = require('micromark-extension-gfm')
var gfmHtml = require('micromark-extension-gfm/html')
var doc = '* [x] contact@example.com ~~strikethrough~~'
var result = micromark(doc, {
extensions: [gfmSyntax()],
htmlExtensions: [gfmHtml]
})
console.log(result)
<ul>
<li><input checked="" disabled="" type="checkbox"> <a href="mailto:contact@example.com">contact@example.com</a> <del>strikethrough</del></li>
</ul>
Or use remark, which will soon include micromark and is pretty stable.
Note that there are more APIs than listed here currently. Those are considered to be in progress.
micromark(doc[, encoding][, options])Compile markdown to HTML.
docMarkdown to parse (string or Buffer)
encodingCharacter encoding to understand doc as when it’s a
Buffer (string, default: 'utf8').
options.defaultLineEndingValue to use for line endings not in doc (string, default: first line
ending or '\n').
Generally, micromark copies line endings ('\r', '\n', '\r\n') in the
markdown document over to the compiled HTML.
In some cases, such as > a, CommonMark requires that extra line endings are
added: <blockquote>\n<p>a</p>\n</blockquote>.
options.allowDangerousHtmlWhether to allow embedded HTML (boolean, default: false).
options.allowDangerousProtocolWhether to allow potentially dangerous protocols in links and images (boolean,
default: false).
URLs relative to the current protocol are always allowed (such as, image.jpg).
For links, the allowed protocols are http, https, irc, ircs, mailto,
and xmpp.
For images, the allowed protocols are http and https.
options.extensionsArray of syntax extensions (Array.<SyntaxExtension>,
default: []).
options.htmlExtensionsArray of HTML extensions (Array.<HtmlExtension>, default:
[]).
string — Compiled HTML.
createSteam(options?)Streaming version of micromark.
Compiles markdown to HTML.
options are the same as the buffering API above.
Available at require('micromark/stream').
There are two types of extensions for micromark:
SyntaxExtension and HtmlExtension.
They can be passed in extensions or
htmlExtensions, respectively.
SyntaxExtensionA syntax extension is an object whose fields are the names of tokenizers:
content (a block of, well, content: definitions and paragraphs), document
(containers such as block quotes and lists), flow (block constructs such as
ATX and setext headings, HTML, indented and fenced code, thematic breaks),
string (things that work in a few places such as destinations, fenced code
info, etc: character escapes and -references), or text (rich inline text:
autolinks, character escapes and -references, code, hard breaks, HTML, images,
links, emphasis, strong).
The values at such objects are character codes, mapping to constructs. The built in constructs are an extension. See it and the existing extensions for inspiration.
HtmlExtensionAn HTML extension is an object whose fields are either enter or exit
(reflecting whether a token is entered or exited).
The values at such objects are names of tokens mapping to handlers.
See the existing extensions for inspiration.
micromark/micromark-extension-footnote
— support footnotesmicromark/micromark-extension-frontmatter
— support frontmatter (YAML, TOML, etc)micromark/micromark-extension-gfm
— support GFM (GitHub Flavored Markdown)micromark/micromark-extension-gfm-autolink-literal
— support GFM autolink literalsmicromark/micromark-extension-gfm-strikethrough
— support GFM strikethroughmicromark/micromark-extension-gfm-table
— support GFM tablesmicromark/micromark-extension-gfm-tagfilter
— support GFM tagfiltermicromark/micromark-extension-gfm-task-list-item
— support GFM tasklistsThe open beta of micromark starts at version 2.0.0 (there was a different
package published on npm as micromark before).
micromark will adhere to semver at 3.0.0.
Use tilde ranges for now: "micromark": "~2.9.2".
It’s safe to compile markdown to HTML if it does not include embedded HTML nor
uses dangerous protocols in links (such as javascript: or data:).
micromark is safe by default if embedded HTML or dangerous protocols are used
too, as it encodes or drops them.
Turning on the allowDangerousHtml or allowDangerousProtocol options for
user-provided markdown opens you up to cross-site scripting (XSS)
attacks.
For more information on markdown sanitation, see
improper-markup-sanitization.md by @chalker.
See security.md in micromark/.github for how to submit
a security report.
See contributing.md in micromark/.github for ways
to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.
Support this effort and give back by sponsoring on OpenCollective!
|
Salesforce 🏅 
| ||||||
Gatsby 🥇
|
Vercel 🥇
|
Netlify
|
Holloway
|
ThemeIsle
|
BoostIO
|
Expo
|
|
You? |
FAQs
small commonmark compliant markdown parser with positional info and concrete tokens
The npm package micromark receives a total of 4,018,166 weekly downloads. As such, micromark popularity was classified as popular.
We found that micromark demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.