View Source MDEx (MDEx v0.1.0)

A fast 100% CommonMark-compatible GitHub Flavored Markdown parser and formatter.

Use Rust's comrak crate under the hood.

Summary

Functions

Convert markdown to HTML.

Convert markdown to HTML with custom opts.

Functions

Convert markdown to HTML.

Examples

iex> MDEx.to_html("# MDEx")
"<h1>MDEx</h1>\n"

iex> MDEx.to_html("Implemented with:\n1. Elixir\n2. Rust")
"<p>Implemented with:</p>\n<ol>\n<li>Elixir</li>\n<li>Rust</li>\n</ol>\n"

Convert markdown to HTML with custom opts.

Options

Accepts all available Comrak Options as keyword lists.

Examples

iex> MDEx.to_html("# MDEx")
"<h1>MDEx</h1>\n"

iex> MDEx.to_html("Implemented with:\n1. Elixir\n2. Rust")
"<p>Implemented with:</p>\n<ol>\n<li>Elixir</li>\n<li>Rust</li>\n</ol>\n"

iex> MDEx.to_html("Hello ~world~ there", extension: [strikethrough: true])
"<p>Hello <del>world</del> there</p>\n"

iex> MDEx.to_html("<marquee>visit https://https://beaconcms.org</marquee>", extension: [autolink: true], render: [unsafe_: true])
"<p><marquee>visit <a href=\"https://https://beaconcms.org\">https://https://beaconcms.org</a></marquee></p>\n"