Markdown Syntax Guide

Text Formatting

Regular text, bold, italic, bold italic, strikethrough, and inline code.

Blockquotes can contain formatting and even multiple paragraphs.

Nested blockquotes work too.

Headings

H1 — Document Title

H2 — Section

H3 — Subsection

H4 — Sub-subsection

H5 — Minor heading
H6 — Smallest heading

Lists

Unordered

  • First item
  • Second item
    • Nested item
    • Another nested
      • Even deeper

Ordered

  1. Step one
  2. Step two
    1. Sub-step A
    2. Sub-step B

Task List

  • [x] Completed task
  • [x] Another done
  • [ ] Still to do

Tables

Left Center Right
L1 C1 R1
L2 C2 R2
L3 C3 R3

Code

typescript
const { html, flavor } = await renderMarkdown(input);
console.log(`Detected: ${flavor.primary}`);

python
import requests

response = requests.post("https://mdfy.app/api/docs", json={
    "markdown": "# Hello World",
})
print(response.json()["id"])  # → "abc123"

Math (KaTeX)

Inline: E=mc2E = mc^2 and x=−b±b2−4ac2ax = \frac{-b \pm \sqrt{b^2-4ac}}{2a}

∫0∞e−x2dx=π2\int_0^{\infty} e^{-x^2} dx = \frac{\sqrt{\pi}}{2}

(ab cd)(x y)=(ax+by cx+dy)\begin{pmatrix} a & b \ c & d \end{pmatrix} \begin{pmatrix} x \ y \end{pmatrix} = \begin{pmatrix} ax + by \ cx + dy \end{pmatrix}

Footnotes

Created by John Gruber[1]. Most popular flavor: GFM[2].

Description Lists

Markdown : A lightweight markup language for creating formatted text.

WASM : WebAssembly — a binary instruction format for a stack-based virtual machine.

  1. See Daring Fireball. ↩︎

  2. github.github.com/gfm. ↩︎