SferaDoc.TemplateEngine.Adapter behaviour (sfera_doc v0.1.0)

Copy Markdown View Source

Behaviour for template engines used by SferaDoc.

Implementations are responsible for parsing template source and rendering it into HTML.

Summary

Types

ast()

@type ast() :: term()

reason()

@type reason() :: any()

Callbacks

parse(t)

@callback parse(String.t()) :: {:ok, ast()} | {:error, reason()}

render(ast, map)

@callback render(ast(), map()) :: {:ok, binary()} | {:error, reason()}