New, tiny, and fast Markdown parser
part of the unified collective
🥇 ZEIT |
🥇 Gatsby |
🥇 Netlify |
Holloway |
You? |
Something like remark (Markdown processor powered by plugins based on unified), but on a lower level: a lexer (in nerdy terms 🤓). Syntax trees have many good things, but they do come with the downside of having a big memory footprint and sometimes being more than what you need.
We’re launching micromark as just an idea. The first line of code still needs to be written. But we imagine it to be:
- small in file size, max 10 kB minzipped, and tiny in memory use
- fast in speed, compared to existing parsers on real world documents
- safe to use, it should safely work on untrusted content by default
- compliant to CommonMark but extensible for GFM (GitHub Flavored Markdown), MDX, etc.
- complete, in that it should give access to all info in the source document
But it’s not:
- something that creates HTML and the like: other projects use micromark for that
- something that creates a syntax tree: remark will use it to do just that
micromark is part of the unified collective. But it will likely not be something you’d directly interact with, unless you’re interested in working on parsers,. It will make high-level tooling better.
Evolving unified shouldn’t just be about new high-level features but also about rethinking core mechanisms. That’s where micromark comes in, so unified can build the most friendly, secure, fast, and extensive bridges between content formats.
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.