5b4: the README's consumer surface

2026-09-03 19:50:47 +02:00
parent c385106b2e
commit 0cf3bfaa39
4 changed files with 106 additions and 45 deletions
@@ -1,9 +1,10 @@
 # The markdown flavour

 The grammar of the extended markdown `adfToMarkdown` emits and `markdownToAdf` parses. Plain
-CommonMark is a subset with three carve-outs: literal text that matches directive syntax below or
-reads as a pipe table is claimed by the flavour, and a matched `~~` pair spells `strike` (escape the
-`:`, `|` or `~` to keep it literal) — and one gap: a CommonMark image fits only as its own
+CommonMark is a subset apart from raw HTML (below), with three carve-outs: literal text that
+matches directive syntax below or reads as a pipe table is claimed by the flavour, and a matched
+`~~` pair spells `strike` (escape the `:`, `|` or `~` to keep it literal) — and one gap: a
+CommonMark image fits only as its own
 title-less paragraph — mid-text and titled images are named errors. The emitted form is contract
 (AGENTS.md §8). Per-node syntaxes build on this grammar in the sections below.