A record with functions that define how to render all possible markdown blocks. These renderers are composed together to give you the final rendered output.

You could render to any type you want. Here are some useful things you might render to:

• Html (using the defaultHtmlRenderer provided by this module)
• Custom Html
• Elements from mdgriffith/elm-ui
• Types from other custom HTML replacement libraries, like rtfeldman/elm-css or tesk9/accessible-html
• Raw Strings with ANSI color codes for setting rich colors in terminal (CLI) output
• Plain text with any formatting stripped away (maybe for a String search feature)

This renders Html in an attempt to be as close as possible to the HTML output in https://github.github.com/gfm/.

Turn a parsing problem into the default String representation.

Try parsing a markdown String into Markdown.Block.Blocks.

Often you'll want to render these Blocks directly:

render renderer markdown =
    markdown
        |> Markdown.parse
        |> Result.mapError deadEndsToString
        |> Result.andThen (\ast -> Markdown.render renderer ast)


deadEndsToString deadEnds =
    deadEnds
        |> List.map deadEndToString
        |> String.join "\n"

But you can also do a lot with the Blocks before passing them through:

• Transform the Blocks (example: make each heading one level deeper)
• Use the blocks to gather metadata about the markdown document (example: building a table of contents from Blocks)

Apply a Markdown.Parser.Renderer to turn parsed Blocks into your rendered markdown view.