Skip to content
This repository has been archived by the owner on Apr 11, 2024. It is now read-only.

Latest commit

 

History

History
46 lines (29 loc) · 1.73 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.73 KB

Cmark

Hex.pm package version Hex.pm package docs Hex.pm package license GitHub Workflow Status Coverage Status (main) Inline docs

Cmark is an Elixir NIF for cmark (C), a parser library following the CommonMark spec.

CommonMark

A strongly defined, highly compatible specification of Markdown

For more information visit http://commonmark.org/.

Install

Prerequisites

You need a C compiler like gcc or clang.

mix.exs

Add this to your dependencies:

{:cmark, "~> 0.10"}

Usage

Cmark.to_html("a markdown string")
#=> "<p>a markdown string</p>\n"

It supports conversions to HTML, XML, Manpage, CommonMark, and Latex.

Latest API docs can be found at: http://hexdocs.pm/cmark/Cmark.html

Licenses