DryDoc.Transformations (DryDoc v0.1.2)

Copy Markdown View Source

Summary

Functions

Github-flavored Markdown and ExDoc use different syntax for Admonitions, aka "alerts", "callouts", "tips", or "notes". This transformation replaces all Github admonition syntax with an alternate form compatible with ExDoc.

Functions

github_admonitions_to_ex_doc_syntax(markdown)

Github-flavored Markdown and ExDoc use different syntax for Admonitions, aka "alerts", "callouts", "tips", or "notes". This transformation replaces all Github admonition syntax with an alternate form compatible with ExDoc.

Github<>ExDoc style mappings (imperfect because admonition types don't match):

NOTE      -> .info    (blue)
TIP       -> .tip     (green)
IMPORTANT -> .info    (blue)
WARNING   -> .warning (yellow)
CAUTION   -> .error   (red)

References: