Skip to Content

Markdown support

mddog draws GitHub Flavored Markdown as GitHub does:

  • Headings, lists, task lists, tables, quotes, rules, and footnotes
  • Code blocks with syntax colors, and diff blocks with added and removed lines
  • Alerts: [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], and [!CAUTION]
  • Math in $...$, $$...$$ and math code blocks
  • Mermaid diagrams in mermaid code blocks
  • Local and remote images, including SVG
  • Safe raw HTML, such as <details>, <mark>, <kbd>, <ruby>, and <div align="center">. Scripts, styles, and event handlers are dropped
  • YAML front matter, as a table of its top-level keys