View Source ExDoc.Markdown behaviour (ExDoc v0.34.2)

Adapter behaviour and conveniences for converting Markdown to HTML.

ExDoc is compatible with any markdown processor that implements the functions defined in this module. The markdown processor can be changed via the :markdown_processor option in your mix.exs.

ExDoc supports the following Markdown parsers out of the box:

ExDoc uses EarmarkParser by default.

Summary

Callbacks

available?()

Returns true if all dependencies necessary are available.

to_ast(t, t)

Converts markdown into HTML.

Functions

get_markdown_processor()

Gets the current markdown processor set globally.

put_markdown_processor(processor)

Changes the markdown processor globally.

to_ast(text, opts \\ [])

Converts the given markdown document to HTML AST.

Callbacks

Link to this callback

available?()

View Source 
@callback available?() :: boolean()

Returns true if all dependencies necessary are available.

Link to this callback

to_ast(t, t)

View Source 
@callback to_ast(String.t(), Keyword.t()) :: term()

Converts markdown into HTML.

Functions

Link to this function

get_markdown_processor()

View Source

Gets the current markdown processor set globally.

Link to this function

put_markdown_processor(processor)

View Source

Changes the markdown processor globally.

Link to this function

to_ast(text, opts \\ [])

View Source

Converts the given markdown document to HTML AST.