View Source Conpipe.Converter.Earmark (conpipe v0.1.0)

This converter uses the Earmark conversion engine to transform markdown to HTML.

See the Earmark Repo for more info.

Summary

Functions

The convert/1 function simply takes a string and returns a converted stringk

Convert Markdown to HTML using Earmark

The convert/4 function can be called directly from Tableau.

Functions

@spec convert(input_text :: String.t()) :: output_text :: String.t()

The convert/1 function simply takes a string and returns a converted stringk

Link to this function

convert(arg, options \\ [])

View Source
@spec convert(
  {input :: String.t(), assigns :: map()},
  options :: keyword()
) :: {output :: String.t(), assigns :: map()}

Convert Markdown to HTML using Earmark

Link to this function

convert(filepath, front_matter, body, opts)

View Source
@spec convert(
  filepath :: String.t(),
  front_matter :: map(),
  body :: String.t(),
  opts :: map()
) ::
  output :: String.t()

The convert/4 function can be called directly from Tableau.

# config/config.exs
config :tableau, :config,
  url: "http://localhost:4999",
  converters: [
    md: Conpipe.Converter.Earmark
  ]

The convert/4 function returns just the converted text. It should not be used in a pipeline.