ex_doc v0.25.5

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

ExDoc extension for the EarmarkParser Markdown parser.

Link to this section Summary

Functions

to_ast(text, opts)

Generate HTML AST.

Link to this section Functions

Link to this function

to_ast(text, opts)

View Source

Generate HTML AST.

Options

  • :gfm - (boolean) turns on Github Flavored Markdown extensions. Defaults to true.

  • :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. Defaults to false.