ExDoc.Markdown.Earmark (ex_doc v0.22.4)

ExDoc extension for the EarmarkParser Markdown parser.

Summary

Functions

Check if the EarmarkParser Markdown parser module is available.

Generate HTML AST.

Functions

available?()

Check if the EarmarkParser Markdown parser module is available.

to_ast(text, opts)

Generate HTML AST.

Options

  • :gfm - boolean. Turns on Github Flavored Markdown extensions. True by default

  • :breaks - boolean. Only applicable if gfm is enabled. Makes all line breaks significant (so every line in the input is a new line in the output)

  • :smartypants - boolean. Turns on smartypants processing, so quotes become curly, two or three hyphens become en and em dashes, and so on. False by default