Give the README's HTML documentation to item 7
CI / gate (push) Successful in 48s
CI / publish (push) Has been skipped

This commit is contained in:
2026-10-02 22:32:26 +02:00
parent 58a7bf91b0
commit d9bacc4072
+6 -6
View File
@@ -52,8 +52,9 @@ and `corpus/README.md` follow, and the tests drop `toEditorNormal`.
### 7. Ship HTML: `adfToHtml`, `htmlToAdf`, and `markdownToHtml` / `htmlToMarkdown` composed through ADF. ### 7. Ship HTML: `adfToHtml`, `htmlToAdf`, and `markdownToHtml` / `htmlToMarkdown` composed through ADF.
Builds on item 6. The CommonMark spec suite runs against `markdownToHtml` from here. The README's tagline and Builds on item 6. The CommonMark spec suite runs against `markdownToHtml` from here. The README
`package.json`'s `description` regain HTML (item 47). documents HTML as it documents markdown, and its tagline and `package.json`'s `description` regain
HTML.
### 45. Replace `isAdfDocument` with a reader returning `Result<AdfDocument>`. ### 45. Replace `isAdfDocument` with a reader returning `Result<AdfDocument>`.
@@ -87,10 +88,9 @@ does and for whom first, then the shortest runnable example. The background goes
endpoint, ticket or "why" note left. The top follows the package-README order: an npm version badge endpoint, ticket or "why" note left. The top follows the package-README order: an npm version badge
and the Gitea Actions badge, a tagline that is also `package.json`'s `description`, a feature list and the Gitea Actions badge, a tagline that is also `package.json`'s `description`, a feature list
and a one-line table of contents, then install and the shortest runnable example; a table of and a one-line table of contents, then install and the shortest runnable example; a table of
everything exported sits near the bottom. The README documents HTML as it documents markdown, the everything exported sits near the bottom. The README names the lossy pair and the flavours it
tagline and `description` naming both, the lossy pair, and the flavours it writes and reads by name writes and reads — GitHub Flavored Markdown's alerts and task lists, Obsidian Flavored Markdown's
— GitHub Flavored Markdown's alerts and task lists, Obsidian Flavored Markdown's callouts — so a callouts — so a search for either finds the package.
search for either finds the package.
### 34. Read emphasis flanking by the whole character beside an astral symbol. ### 34. Read emphasis flanking by the whole character beside an astral symbol.