| table container |
|
| header cell |
| |
data cell |
---
## 10. Math and Technical Notation
### 10.1 Inline Math
Inline math often looks like $x^2 + y^2 = z^2$.
### 10.2 Display Math
$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$
### 10.3 Matrix Example
$$
A =
\begin{bmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{bmatrix}
$$
### 10.4 Aligned Equations
$$
\begin{aligned}
f(x) &= x^2 + 1 \\
f'(x) &= 2x
\end{aligned}
$$
### 10.5 Piecewise Function
$$
f(x) =
\begin{cases}
-1, & x < 0 \\
0, & x = 0 \\
1, & x > 0
\end{cases}
$$
### 10.6 Logic and Set Symbols
- $\forall x \in \mathbb{R}$
- $\exists y \in \mathbb{N}$
- $A \subseteq B$
- $p \Rightarrow q$
---
## 11. Diagrams
### 11.1 Mermaid Flowchart
```mermaid
flowchart TD
A[Plain text source] --> B[Markdown parser]
B --> C[AST / token stream]
C --> D[Renderer]
D --> E[Preview or export]
```
### 11.2 Mermaid Sequence Diagram
```mermaid
sequenceDiagram
participant Author
participant Editor
participant Parser
participant Renderer
Author->>Editor: Write markdown
Editor->>Parser: Parse content
Parser-->>Renderer: Structured tokens
Renderer-->>Author: Visible preview
```
### 11.3 Mermaid State Diagram
```mermaid
stateDiagram-v2
[*] --> Draft
Draft --> Reviewed
Reviewed --> Published
Published --> Archived
```
### 11.4 Mermaid Gantt Chart
```mermaid
gantt
title Markdown Documentation Workflow
dateFormat YYYY-MM-DD
section Drafting
Write outline :a1, 2026-06-10, 1d
Fill examples :a2, after a1, 2d
section Review
Technical review :b1, after a2, 1d
Update examples :b2, after b1, 1d
```
### 11.5 Mermaid Class Diagram
```mermaid
classDiagram
class Document {
+frontMatter
+sections
+links
}
class Renderer {
+renderHtml()
+renderPreview()
}
Document --> Renderer
```
---
## 12. Advanced Markdown
### 12.1 Footnotes
Footnotes are useful for side remarks and citations.[^commonmark-note]
[^commonmark-note]: Footnotes are not part of original Markdown, but are common in extended flavors.
### 12.2 Abbreviations
*[AST]: Abstract Syntax Tree
*[GFM]: GitHub Flavored Markdown
*[TOC]: Table of Contents
An AST is often produced before rendering, and a TOC can be derived from headings.
### 12.3 Collapsible Sections
Click to expand a collapsible block
This is useful for optional detail, logs, notes, or spoiler-like hidden content.
- It can contain lists.
- It can contain code.
- It can contain paragraphs.
### 12.4 HTML Comments
### 12.5 Mixed HTML and Markdown
Centered HTML block inside a Markdown document.
### 12.6 Citation-Style Text
Some scholarly workflows use citation syntax such as [@doe2024markdown] or
multiple references like [@doe2024markdown; @smith2025gfm].
### 12.7 Checklist Table
| Capability | Available | Notes |
| ---------------------- |:---------:| -------------------------- |
| Standard Markdown | ✅ | core syntax |
| Tables | ✅ | GFM-style |
| Task lists | ✅ | GFM-style |
| Footnotes | ✅ | extension |
| Inline HTML | ✅ | selective behavior varies |
| Every extension stable | ⚠️ | depends on renderer/editor |
### 12.8 Admonition Summary
> [!SUMMARY]
> Markdown often becomes most useful when plain readability, predictable parsing,
> and minimal syntax noise all remain in balance.
---
## 13. HTML Inside Markdown
### 13.1 Inline HTML
This sentence includes a styled span.
### 13.2 Block HTML
HTML blocks may or may not render depending on the application's rules.
### 13.3 Ruby Annotation
Markdown
### 13.4 Description List in Raw HTML
- Markdown
- Plain-text markup.
- Renderer
- Turns source into output.
### 13.5 HTML and Markdown Boundary Example
This blockquote is raw HTML rather than Markdown blockquote syntax.
---
## 14. CommonMark and GFM Edge Cases
### 14.1 Lazy Continuation in Blockquotes
> A blockquote can continue
> without `>` on every visual line in some parsing situations.
### 14.2 Tight vs Loose Lists
- tight item one
- tight item two
- loose item one
- loose item two
### 14.3 Ordered List Starting Number
42. This list starts at 42 in source.
43. The next item follows.
### 14.4 Backticks Inside Inline Code
Use double backticks when the code itself contains a backtick: `` `code` ``.
### 14.5 Emphasis Ambiguity
Examples that parsers treat carefully:
- `foo_bar_baz`
- `*a **b** c*`
- `**a *b* c**`
### 14.6 HTML Entity Examples
- &
- <
- >
- ©
### 14.7 Link Reference Definitions Far Away From Use
This paragraph references [a deferred definition][deferred-link].
[deferred-link]: https://example.com/deferred
### 14.8 Unordered Marker Mixing
- first style
* second style
+ third style
### 14.9 Fenced Code Directly After List
1. Step one
2. Example code:
```json
{
"ok": true
}
```
### 14.10 Raw Angle Brackets
Literal text with angle brackets may need escaping: `<tag>`.
### 14.11 Bare Underscore Examples
Identifiers like `snake_case_name` should usually not become emphasis.
### 14.12 Inline HTML Table Mention
The string `` in a paragraph is not the same thing as a real HTML table block.
---
## 15. Reference Material
1. Gruber, J. *Markdown*.
2. CommonMark Specification.
3. GitHub Flavored Markdown Spec.
4. Markdown Guide.
5. GitHub Docs on writing and formatting Markdown.
---
## Appendix A: Stress Tests
### A.1 Long Equation
$$
f(x) =
\int_{0}^{\infty}
\frac{x^n e^{-x/\theta}}{\Gamma(n)\theta^n}
\left(
\sum_{k=0}^{m}
\binom{m}{k}
\alpha^k
\right)
\, dx
$$
### A.2 Unicode Symbols
Common symbols that often appear in Markdown-heavy technical documents:
- Greek: α, β, γ, δ, ε, λ, μ, π, σ, φ, ω
- Operators: ∑, ∏, ∫, ∂, ∇, ≈, ≠, ≤, ≥
- Sets: ℕ, ℤ, ℚ, ℝ, ℂ
- Arrows: ←, ↑, →, ↓, ↔, ⇒, ⇔
### A.3 Badge Table
| Badge | Meaning |
| ------------------------------------------------------------- | ----------------------------- |
|  | This is a reference document |
|  | Targets GFM-compatible syntax |
|  | Includes display math |
|  | Includes inline/raw HTML |
### A.4 Mixed Nested Blocks
> [!IMPORTANT]
> Nested structures inside a callout can stress a renderer:
>
> 1. ordered item
> 2. second item
> - nested bullet
> - nested bullet with `code`
>
> ```text
> fenced block inside callout
> ```
### A.5 Source-Focused Summary
> [!SUMMARY]
> This document covers headings, paragraphs, emphasis, links, images, lists,
> task lists, definition lists, blockquotes, admonitions, code fences, tables,
> math, diagrams, footnotes, abbreviations, comments, raw HTML, autolinks,
> reference links, escapes, nested fences, Unicode, and several parser edge cases.
|