https://github.com/devinus/markdown

A simple Elixir Markdown to HTML conversion library
https://github.com/devinus/markdown

Last synced: about 2 months ago
JSON representation

A simple Elixir Markdown to HTML conversion library

• Host: GitHub
• URL: https://github.com/devinus/markdown
• Owner: devinus
• License: unlicense
• Created: 2014-01-31T23:17:35.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-04-17T11:08:41.000Z (over 4 years ago)
• Last Synced: 2024-10-12T00:51:55.399Z (2 months ago)
• Language: C
• Size: 14.6 KB
• Stars: 87
• Watchers: 5
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - C - Implemented entirely as a NIF binding to the Hoedown library. (Markdown)
• fucking-awesome-elixir - Markdown - Implemented entirely as a NIF binding to the Hoedown library. (Markdown)
• awesome-elixir - Markdown - Implemented entirely as a NIF binding to the Hoedown library. (Markdown)

README

        
# Markdown

A simple Elixir [Markdown][1] to HTML conversion library.

Implemented entirely as a [NIF][2] binding to the [Hoedown][3] library.

## Usage

```iex

iex> Markdown.to_html "# Hello World"

"
Hello World
\n"

iex> Markdown.to_html "http://elixir-lang.org/", autolink: true

"
http://elixir-lang.org/
\n"

```


### Options

* `:tables` - Enables Markdown Extra style tables (default: `false`)

* `:fenced_code` - Enables fenced code blocks (default: `false`)

* `:autolink` - Automatically turn URLs into links (default: `false`)

## TODO

* Use dirty schedulers [when available][4]

* Add more options to the NIF that are [available in Hoedown][5]

* ANSI renderer

[1]: http://daringfireball.net/projects/markdown/

[2]: http://www.erlang.org/doc/tutorial/nif.html

[3]: https://github.com/hoedown/hoedown

[4]: https://github.com/zambal/markdown/commit/792a414de074d96ac47b5b52d212b7197ce04462

[5]: https://github.com/hoedown/hoedown/blob/8ab482af918f6b5c296dca80f0c67e924c06b5c2/bin/hoedown.c#L49