ExDoc.Markdown behaviour (ExDoc v0.40.1)

Copy Markdown 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. Note that doing such change is global.

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

to_ast(text, opts \\ [])

Converts the given markdown document to HTML AST.

Callbacks

available?()

@callback available?() :: boolean()

Returns true if all dependencies necessary are available.

to_ast(t, t)

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

Converts markdown into HTML.

Functions

to_ast(text, opts \\ [])

Converts the given markdown document to HTML AST.

Options

  • :markdown_processor - The markdown processor to use, either as a module or a {module, keyword} tuple

All other options are passed through to the markdown processor.