Markdown/Flavor

• Markdown Flavors / Syntaxes / Variants

  • See also Markdown/Guide/Extended Syntax

  • Quick reference: dialects with first-class interactive or data-storage features

    • Dialect	Live widgets / code	Structured metadata	Typical storage mechanism
      Logseq MD	Queries, Agile boards	property:: blocks	In-file key-value pairs
      Obsidian + Dataview	Dataview tables & JS	YAML front-matter, inline fields	YAML + inline
      R/Markdown	Shiny, HTML widgets	YAML params	YAML header
      R/Quarto	Shiny, Observable, Jupyter	YAML header	YAML header
      MDX	React components	ES module imports	JavaScript objects
      GFM / GLFM	Task-list checkboxes, Mermaid	Limited (Front matter on GitLab)	Front matter or repo data

  • Examples

    • Markdown/Flavor/CommonMark

    • Markdown/Flavor/Github GitHub Flavored Markdown (GFM)

    • Markdown/Flavor/GitLab GitLab Flavored Markdown (GLFM)

    • Logseq/Flavored Markdown

    • App/Obsidian/Markdown + Dataview

    • R/Markdown & R/Quarto

      • Why – weave prose with executable code chunks for reproducible research; Quarto generalises R Markdown to any language (R, Python, Julia, Observable) and modern interactivity
        • Bookdown
        • Quarto
      • Use – academic papers, Shiny dashboards, corporate reports
      • Renderers – R (rmarkdown), Quarto CLI (Rust+Go), knitr, Jupyter kernels
      • Interactive / data – HTML widgets, embedded Shiny apps, Observable JS, parameterised reports; YAML front-matter stores document-level metadata and runtime params

    • MDX (Markdown + JSX)

      • Why – let React components live inline with Markdown for docs that need live code demos or UI componentsReadMe
      • Use – nextjs / Docusaurus / Storybook sites, ReadMe.io docs
      • Renderers – Node toolchain @mdx-js (Babel/ESBuild), integrated in React, Astro, SvelteKit via adapters
      • Interactive / data – any React component (charts, sandboxes) can read remote data or local JSON at runtime

    • AsciiDoc / Asciidoctor

      • Why – richer technical-writing features (attributes, macros, includes) and direct DocBook export; emerged before CommonMark for book manualsAsciidoctor Docs
      • Use – Red Hat docs, Spring Framework guides, O’Reilly book tooling
      • Renderers – Ruby (Asciidoctor), Java (AsciidoctorJ), JS (asciidoctor.js), Python (asciidoc3)AsciiDoc3
      • Interactive / data – attribute substitutions, UI macros, PlantUML & GraphViz extensions; can pull external files and variables at build time

    • Djot

      • Why – John MacFarlane’s attempt to keep CommonMark simplicity but add attributes, math, footnotes, and generic containers while parsing faster Djot
      • Status / use – early adopters in static-site tooling; Pandoc can convert to/from Djot
      • Renderers – official JS implementation plus Lua, Rust, Go, Prolog parsersDjot
      • Interactive / data – element-level attributes make it easier to attach metadata; no built-in live interactivity yet
    • Markdown/Flavor/MultiMarkdown

      • MultiMarkdown

        • Origin & purpose – 2005 ±, Fletcher T. Penney wanted scholarly bells-and-whistles—tables, footnotBest Of Webs-references, math—while staying readable in plain text.
        • Syntax extras – footnotes, BibTeX citations, column-aligned tables, LaTeX math, figure/table cGitHubumbering & cross-links, definition lists, smart quotes, perGitHubAML-like metadata headeGitHub
        • Data/storage angle – the top-of-file metadata block (Title: …, custom Key: …) is first-class; multimarkdown --extract=Key makes docs double as lightweight data stores for build pipelines.
        • **OutpuGitHub DocsPDF, EPUB 3, OPML, Flat ODT, RTF; switch via a single CLI flag.
        • Adoption – niche but steady among academic/technical writersGitHuboser & Marked 2 on macOS, Leanpub manuscripts, Joplin table plugin, Pandoc conversions.
        • Renderers / bindings
          • C reference library libMultiMarkdown-6.
          • Python pymmd wrapper.
          • Ruby gems rpeg-multimarkdown2, multimarkdown-cli. GitLab Docsll Pandoc reader/writer.
          • JavaScript via WASM builds and markdown-it-multimd-table plugin.
          • Cross-platform CLI binaries (macOS, Windows, Linux).
        • Interactivity – core spec is static; metadata extraction enables build-time automation, and HTML output can host JS (MathJax, charts), but MultiMarkdown itself embeds no runtime widgets.
  • C-level libraries exist for CommonMark, GFM, and Djot; Ruby and JavaScript dominate AsciiDoc and MDX toolchains; R and multi-language kernels drive R Markdown and Quarto.