ExDoc.Markdown behaviour (ex_doc v0.26.0) View Source

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.

Link to this section Summary

Callbacks

Returns true if all dependencies necessary are available.

Converts markdown into HTML.

Functions

Gets the current markdown processor set globally.

Changes the markdown processor globally.

Converts the given markdown document to HTML AST.

Link to this section Callbacks

Specs

available?() :: boolean()

Returns true if all dependencies necessary are available.

Specs

to_ast(String.t(), Keyword.t()) :: term()

Converts markdown into HTML.

Link to this section 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.