cmark.ex 0 travis-ci

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

Cmark

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

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

Related Repositories

ex_doc

ex_doc

ExDoc produces HTML and EPUB documentation for Elixir projects ...

discount.ex

discount.ex

Elixir NIF for discount, a Markdown parser ...

awesome-elixir

awesome-elixir

A curated list of amazingly awesome Elixir and Erlang libraries, resources and s ...

awesome-elixir

awesome-elixir

A curated list of amazingly awesome Elixir and Erlang libraries, resources and s ...

awesome-elixir

awesome-elixir

A curated list of amazingly awesome Elixir and Erlang libraries, resources and s ...


Top Contributors

asaaki gmile pokvo lowks

Releases

-   v0.6.10 zip tar
-   v0.6.9 zip tar
-   v0.6.8 zip tar
-   v0.6.7 zip tar
-   v0.6.6 zip tar
-   v0.6.5 zip tar
-   v0.6.4 zip tar
-   v0.6.3 zip tar
-   v0.6.2 zip tar
-   v0.6.1 zip tar
-   v0.6.0 zip tar
-   v0.5.7 zip tar
-   v0.5.6 zip tar
-   v0.5.5 zip tar
-   v0.5.4 zip tar
-   v0.5.3 zip tar
-   v0.5.2 zip tar
-   v0.5.1 zip tar
-   v0.5.0 zip tar
-   v0.4.3 zip tar
-   v0.4.2 zip tar
-   v0.4.1 zip tar
-   v0.3.3 zip tar
-   v0.3.2 zip tar
-   v0.3.1 zip tar
-   v0.3.0 zip tar
-   v0.2.0 zip tar
-   v0.1.1 zip tar