ex_doc_simple_markdown v0.5.1 ExDocSimpleMarkdown.Extension behaviour

Link to this section Summary

Callbacks

A callback called once before any conversion/doc generation is performed. Use this to perform any required initialisation.

A callback to modify the text input.

A callback to modify the HTML output.

A callback to modify the rule list before converting.

Link to this section Callbacks

Specs

init() :: :ok

A callback called once before any conversion/doc generation is performed. Use this to perform any required initialisation.

Link to this callback

input(text, opts)

Specs

input(text :: String.t(), opts :: any()) :: String.t()

A callback to modify the text input.

Link to this callback

output(html, opts)

Specs

output(html :: String.t(), opts :: any()) :: String.t()

A callback to modify the HTML output.

Link to this callback

rules(rules, opts)

Specs

rules(rules :: [Parsey.rule()], opts :: any()) :: [Parsey.rule()]

A callback to modify the rule list before converting.