Packages

cmark

0.3.0
0.10.0 0.9.0 0.8.0 0.7.0 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.7 0.5.6 0.5.5 0.5.4 0.5.3 0.5.2 0.5.1 0.5.0 0.4.3 0.4.2 0.4.1 0.3.3 0.3.2 0.3.1 0.3.0 0.3.0-dev1 0.2.0 0.1.1

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

HexDocs

Current section

Files

Jump to
Readme
33 Versions
0 Dependencies
Dependants
Files
Activity
cmark README.md
Raw

README.md 

# Cmark



[![Hex.pm package version](https://img.shields.io/hexpm/v/cmark.svg?style=flat-square)](https://hex.pm/packages/cmark)

[![Hex.pm package license](https://img.shields.io/hexpm/l/cmark.svg?style=flat-square)](https://github.com/asaaki/cmark.ex/blob/master/LICENSE)

[![Build Status (master)](https://img.shields.io/travis/asaaki/cmark.ex/master.svg?style=flat-square)](https://travis-ci.org/asaaki/cmark.ex)

[![Support via Gratipay](http://img.shields.io/gratipay/asaaki.svg?style=flat-square)](https://gratipay.com/asaaki)



Elixir NIF for [libcmark](https://github.com/jgm/CommonMark), a parser library following the [CommonMark](http://commonmark.org/) spec.



## Install



### Prerequisites



You need `make` (mostly present) and `cmake` (maybe not present, please install first).



If you want to run the specs, also `python` needs to be installed.



### mix.exs



```elixir

{ :cmark, "~> 0.3" }

```



## Usage



```elixir

Cmark.to_html "a markdown string"

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

```



## License



[MIT/X11](./LICENSE)