Packages

Earmark is a pure-Elixir Markdown converter. It is intended to be used as a library (just call Earmark.as_html), but can also be used as a command-line tool (run mix escript.build first). Output generation is pluggable.

Retired package: Deprecated - Earmark is no longer maintained. Migrate to a replacement, for example MDEx (https://hex.pm/packages/mdex).

Current section

Files

Jump to
earmark lib earmark types.ex
Raw

lib/earmark/types.ex

defmodule Earmark.Types do
defmacro __using__(_options \\ []) do
quote do
@type token :: {atom, String.t}
@type tokens :: list(token)
@type numbered_line :: %{line: String.t, lnb: number}
@type message_type :: :warning | :error
@type message :: {message_type, number, String.t}
@type maybe(t) :: t | nil
@type inline_code_continuation :: {nil | String.t, number}
end
end
end