markd

Yet another markdown parser built for speed, written in Crystal, Compliant to CommonMark specification (v0.27). Copy from commonmark.js.

Installation

Add this to your application's shard.yml:

dependencies:
  markd:
    github: icyleaf/markd

Quick start

require "markd"

markdown = <<-MD
# Hello Markd

> Yet another markdown parser built for speed, written in Crystal, Compliant to CommonMark specification.
MD

html = Markd.to_html(markdown)

Also here is an options to configure the parse and render.

options = Markd::Options.new(smart: true, safe: true)
Markd.to_html(markdown, options)

Options

Advanced

If you want use custom renderer, it can!

class CustomRenderer < Markd::Renderer

  def strong(node, entering)
  end

  # more methods following in render.
end

options = Markd::Options.new(time: true)
document = Markd::Parser.parse(markdown, options)
renderer = CustomRenderer.new(options)

html = renderer.render(document)

Performance

First of all, Markd is slower than Crystal Built-in Markdown which it is a lite version, only apply for generte Cystal documents (#4496, #4613).

Here is the result of a sample markdown file parse at MacBook Pro Retina 2015 (2.2 GHz):

Crystal Markdown   3.28k (305.29µs) (± 0.92%)       fastest
           Markd 305.36  (  3.27ms) (± 5.52%) 10.73× slower

Recently, i'm working to compare the other popular commonmark parser, the code is stored in benchmarks.

Donate

Markd is a open source, collaboratively funded project. If you run a business and are using Markd in a revenue-generating product, it would make business sense to sponsor Markd development. Individual users are also welcome to make a one time donation if Totem has helped you in your work or personal projects.

You can donate via Paypal.

How to Contribute

Your contributions are always welcome! Please submit a pull request or create an issue to add a new question, bug or feature to the list.

All Contributors are on the wall.

You may also like

• halite - HTTP Requests Client with a chainable REST API, built-in sessions and middlewares.
• totem - Load and parse a configuration file or string in JSON, YAML, dotenv formats.
• poncho - A .env parser/loader improved for performance.
• popcorn - Easy and Safe casting from one type to another.
• fast-crystal - 💨 Writing Fast Crystal 😍 -- Collect Common Crystal idioms.

License

MIT License © icyleaf