Text.Markdown

This is the main module of the Markdown library.

It is probably the only one you will need to import with its main three
functions `toHtml`, `parse` and `parse_either` further described below.

Reexports

Definitions

parse_either : String -> Either MdError Markdown

  Parses a Markdown string with a possibility of failure.
  
  This function is intended for debugging as "normally" the parser shouldn't
  fail. If this happens, run this function and kindly report the issue with
  a minimal example.

Totality: total
Visibility: export

parse : String -> Markdown

  Parses a Markdown string.
  
  In case of failure of the parser (which shouldn't happen!) returns an empty
  markdown.
  
  If a failure would happen, this is a bug. Kindly report it with a minimal
  example using `parse_either`.

Totality: total
Visibility: export

toHtml : String -> String

  Converts a markdown string to a HTML string.

Visibility: export