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

ExDoc extension for the EarmarkParser Markdown parser.

Link to this section Summary

Functions

Check if the EarmarkParser Markdown parser module is available.

Generate HTML AST.

Link to this section Functions

Check if the EarmarkParser Markdown parser module is available.

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.