ex_doc v0.23.0

ExDoc.Markdown.Earmark (ex_doc v0.23.0) View Source

ExDoc extension for the EarmarkParser Markdown parser.

Link to this section Summary

Functions

available?()

Check if the EarmarkParser Markdown parser module is available.

to_ast(text, opts)

Generate HTML AST.

Link to this section Functions

Link to this function

available?()

View Source

Check if the EarmarkParser Markdown parser module is available.

Link to this function

to_ast(text, opts)

View Source

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