Packages

earmark

0.2.1
1.5.0-pre1 retired 1.5.0-pre retired 1.4.49 retired 1.4.48 retired 1.4.47 retired 1.4.46 retired 1.4.45 retired 1.4.44 retired 1.4.43 retired 1.4.42 retired 1.4.41 retired 1.4.40 retired 1.4.39 retired 1.4.38 retired 1.4.37 retired 1.4.36 retired 1.4.35 retired 1.4.34 retired 1.4.33 retired 1.4.32 retired 1.4.31 retired 1.4.30 retired 1.4.29 retired 1.4.28 retired 1.4.27 retired 1.4.26 retired 1.4.25 retired 1.4.24 retired 1.4.23 retired 1.4.22 retired 1.4.21 retired 1.4.20 retired 1.4.19 retired 1.4.18 retired 1.4.17 retired 1.4.16 retired 1.4.16-pre2 retired 1.4.16-pre1 retired 1.4.16-pre retired 1.4.15 retired 1.4.14 retired 1.4.13 retired 1.4.12 retired 1.4.10 retired 1.4.9 retired 1.4.8 retired 1.4.7 retired 1.4.6 retired 1.4.5 retired 1.4.4 retired 1.4.3 retired 1.4.2 retired 1.4.1 retired 1.4.0 retired 1.3.6 retired 1.3.5 retired 1.3.4 retired 1.3.3 retired 1.3.2 retired 1.3.1 retired 1.3.0 retired 1.2.6 retired 1.2.5 retired 1.2.4 retired 1.2.3 retired 1.2.2 retired 1.2.1 retired 1.2.0 retired 1.1.1 retired 1.1.0 retired 1.0.3 retired 1.0.2 retired 1.0.1 retired 1.0.0 retired 0.2.1 retired 0.2.0 retired 0.1.19 retired 0.1.18 retired 0.1.17 retired 0.1.16 retired 0.1.15 retired 0.1.14 retired 0.1.13 retired 0.1.12 retired 0.1.10 retired 0.1.9 retired 0.1.8 retired 0.1.7 retired 0.1.6 retired 0.1.5 retired 0.1.4 retired 0.1.3 retired 0.1.2 retired 0.1.1 retired 0.1.0 retired

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).
HexDocs

Current section

Files

Jump to
Readme
95 Versions
0 Dependencies
114 Dependants
1 Advisory
Files
Activity
earmark lib earmark parser.ex
Raw

lib/earmark/parser.ex 

defmodule Earmark.Parser do



  alias Earmark.Line

  alias Earmark.Block





  def parse(text_lines), do: parse(text_lines, false)

  def parse(text_lines, recursive)

  when is_boolean(recursive), do: parse(text_lines, %Earmark.Options{}, recursive)



  def parse(text_lines, options = %Earmark.Options{}, recursive \\ false) do

    # add blank lines before and after

    [ "" | text_lines ++ [""] ] 

    |> Earmark.pmap(fn (line) -> Line.type_of(line, options, recursive) end)

    |> Block.parse

  end



  ################################################################

  # Traverse the block list and extract the footnote definitions #

  ################################################################



  def handle_footnotes(blocks, options, map_func) do

    { footnotes, blocks } = Enum.partition(blocks, &is_footnote_def/1)

    footnotes = map_func.(blocks, &find_footnote_links/1)

                |> List.flatten

                |> get_footnote_numbers(footnotes, options)

    blocks = create_footnote_blocks(blocks, footnotes)

    footnotes = map_func.(footnotes, &({&1.id, &1})) |> Enum.into(HashDict.new)

    { blocks, footnotes }

  end



  defp is_footnote_def(%Block.FnDef{}), do: true

  defp is_footnote_def(_block), do: false



  defp find_footnote_links(%Block.Para{lines: lines}), do: Enum.map(lines, &find_footnote_links/1)



  defp find_footnote_links(line) when is_bitstring(line) do

    Regex.scan(~r{\[\^([^\]]+)\]}, line)

    |> Enum.map(&(tl(&1) |> hd))

  end

  defp find_footnote_links(_), do: []



  def get_footnote_numbers(refs, footnotes, options) do

    Enum.reduce(refs, [], fn(ref, list) ->

      case Enum.find(footnotes, &(&1.id == ref)) do

        note = %Block.FnDef{} -> number = length(list) + options.footnote_offset

                                 note = %Block.FnDef{ note | number: number }

                                 [ note | list ]

        _                     -> list # TODO inline footnotes

      end

    end)

  end



  defp create_footnote_blocks(blocks, []), do: blocks



  defp create_footnote_blocks(blocks, footnotes) do

    footnote_block = %Block.FnList{blocks: Enum.sort_by(footnotes, &(&1.number))}

    Enum.concat(blocks, [footnote_block])

  end

  

end