Tableau.Converter behaviour (tableau v0.24.0)

View Source

Defines the interface for the converter module used by extensions to parse markup files.

Summary

Callbacks

convert(filepath, front_matter, content, opts)

@callback convert(
  filepath :: String.t(),
  front_matter :: map(),
  content :: String.t(),
  opts :: Keyword.t()
) ::
  String.t()

Converts content into HTML.

Is given the file path, the content of the files (sans front matter), the front matter, and a list of options.