MDEx

Fast and Extensible Markdown for Elixir.

Features

Fast
Compliant with the CommonMark spec
Plugins
Formats:
- Markdown (CommonMark)
- HTML
- JSON
- XML
- Quill Delta
Floki-like Document AST
Req-like Document pipeline API
GitHub Flavored Markdown
Discord and GitLab Flavored-ish Markdown
Wiki-style links
Streaming incomplete fragments
Emoji shortcodes
Built-in Syntax Highlighting for code blocks
Code Block Decorators
HTML sanitization
~MD Sigil for Markdown, HTML, JSON, XML, and Quill Delta

Examples

Livebook examples are available at Pages / Examples

Installation

Add :mdex dependency:

def deps do
  [
    {:mdex, "~> 0.8"}
  ]
end

Or use Igniter:

mix igniter.install mdex

Usage

iex> MDEx.to_html!("# Hello :smile:", extension: [shortcodes: true])
"<h1>Hello 😄</h1>"

iex> MDEx.new(markdown: "# Hello :smile:", extension: [shortcodes: true]) |> MDEx.to_html!()
"<h1>Hello 😄</h1>"

iex> import MDEx.Sigil
iex> ~MD[# Hello :smile:]HTML
"<h1>Hello 😄</h1>"

iex> import MDEx.Sigil
iex> ~MD[# Hello :smile:]
#MDEx.Document(3 nodes)<
├── 1 [heading] level: 1, setext: false
│   ├── 2 [text] literal: "Hello "
│   └── 3 [short_code] code: "smile", emoji: "😄"
>

iex> MDEx.new(streaming: true)
...> |> MDEx.Document.put_markdown("**Install")
...> |> MDEx.to_html!()
"<p><strong>Install</strong></p>"

Foundation

The library is built on top of:

comrak - a fast Rust port of GitHub's CommonMark parser
ammonia for HTML Sanitization
autumnus for Syntax Highlighting

Used By

Are you using MDEx and want to list your project here? Please send a PR!

Motivation

MDEx was born out of the necessity of parsing CommonMark files, to parse hundreds of files quickly, and to be easily extensible by consumers of the library.

earmark is extensible but can't parse all kinds of documents and is slow to convert hundreds of markdowns.
md is very extensible but the doc says "If one needs to perfectly parse the common markdown, Md is probably not the correct choice" and CommonMark was a requirement to parse many existing files.
markdown is not precompiled and has not received updates in a while.
cmark is a fast CommonMark parser but it requires compiling the C library, is hard to extend, and was archived on Apr 2024.

Comparison

Feature	MDEx	Earmark	md	cmark
Active	✅	✅	✅	❌
Pure Elixir	❌	✅	✅	❌
Extensible	✅	✅	✅	❌
Syntax Highlighting	✅	❌	❌	❌
Code Block Decorators	✅	❌	❌	❌
Streaming (fragments)	✅	❌	❌	❌
AST	✅	✅	✅	❌
AST to Markdown	✅	⚠️²	❌	❌
To HTML	✅	✅	✅	✅
To JSON	✅	❌	❌	❌
To XML	✅	❌	❌	✅
To Manpage	❌	❌	❌	✅
To LaTeX	❌	❌	❌	✅
To Quill Delta	✅	❌	❌	❌
Emoji	✅	❌	❌	❌
GFM³	✅	✅	❌	❌
GitLab⁴	⚠️¹	❌	❌	❌
Discord⁵	⚠️¹	❌	❌	❌

Partial support
Possible with earmark_reversal
GitHub Flavored Markdown
GitLab Flavored Markdown
Discord Flavored Markdown

Benchmark

A benchmark is available to compare existing libs:

Name              ips        average  deviation         median         99th %
mdex          4546.79        0.22 ms     ±6.19%        0.22 ms        0.27 ms
md             475.87        2.10 ms     ±3.35%        2.09 ms        2.27 ms
earmark        142.21        7.03 ms     ±2.84%        6.98 ms        7.68 ms

Comparison:
mdex          4546.79
md             475.87 - 9.55x slower +1.88 ms
earmark        142.21 - 31.97x slower +6.81 ms

Memory usage statistics:

Comparison:
mdex           0.152 MB
md              6.37 MB - 41.86x memory usage +6.21 MB
earmark         4.34 MB - 28.51x memory usage +4.18 MB

The most performance gain is using the ~MD sigil to compile the Markdown instead of parsing it at runtime, prefer using it when possible.

To finish, a friendly reminder that all libs have their own strengths and trade-offs so use the one that better suits your needs.

Acknowledgements

comrak crate for all the heavy work on parsing Markdown and rendering HTML
Floki for the AST
Req for the pipeline API
Logo based on markdown-mark