Elixir NIF for cmark (C), a parser library following the CommonMark spec, a compatible implementation of Markdown.
C C++ Elixir Makefile
Latest commit c6004b3 Nov 21, 2016 @asaaki committed on GitHub Merge pull request #24 from asaaki/update/dependency
Update dependencies (C lib + mix)

README.md

Cmark

Hex.pm package version Hex.pm package docs Hex.pm package license Build Status (master) Coverage Status (master) Inline docs Deps Status

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

CommonMark

A strongly specified, highly compatible implementation 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.6"}

Usage

Quick example

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

More detailed documentation at http://hexdocs.pm/cmark/.

Available functions

HTML

  • Cmark.to_html/1
  • Cmark.to_html/2
  • Cmark.to_html/3
  • Cmark.to_html_each/2
  • Cmark.to_html_each/3

XML

  • Cmark.to_xml/1
  • Cmark.to_xml/2
  • Cmark.to_xml/3
  • Cmark.to_xml_each/2
  • Cmark.to_xml_each/3

Manpage

  • Cmark.to_man/1
  • Cmark.to_man/2
  • Cmark.to_man/3
  • Cmark.to_man_each/2
  • Cmark.to_man_each/3

CommonMark

  • Cmark.to_commonmark/1
  • Cmark.to_commonmark/2
  • Cmark.to_commonmark/3
  • Cmark.to_commonmark_each/2
  • Cmark.to_commonmark_each/3

LaTeX

  • Cmark.to_latex/1
  • Cmark.to_latex/2
  • Cmark.to_latex/3
  • Cmark.to_latex_each/2
  • Cmark.to_latex_each/3

Documentation

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

Licenses