3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-21 15:42:58 +01:00

Answer product-owner round 1: the README states the alternate marker and the * escape, and the changelog names which writer dropped ::listBreak

This commit is contained in:
2026-10-09 15:17:24 +02:00
committed by Lillem4n
parent 3ba0339f69
commit a0166982b1
2 changed files with 7 additions and 5 deletions
+3 -3
View File
@@ -3,9 +3,9 @@
## Unreleased
- **Breaking:** a list whose bullet character or ordered delimiter changes reads as two lists, as
CommonMark reads it: `- a` then `* b`, `1. a` then `1) b`. Both writers give a list right after
one of its kind the other marker, `* ` or `1)`, in place of the `::listBreak` separator. Convert
stored markdown per `MIGRATION.md`.
CommonMark reads it: `- a` then `* b`, `1. a` then `1) b`. `adfToLosslessMarkdown` gives a list
right after one of its kind the other marker, `* ` or `1)`, in place of the `::listBreak`
separator, and `adfToPortableMarkdown` does the same. Convert stored markdown per `MIGRATION.md`.
- **Breaking:** each call names the markdown it reads or writes. `adfToMarkdown` and `markdownToAdf`
are now `adfToLosslessMarkdown` and `losslessMarkdownToAdf`. A bot's or a model's markdown reads
in `portableMarkdownToAdf`, and markdown known to be strict CommonMark in the new