mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-21 07:32: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:
+3
-3
@@ -3,9 +3,9 @@
|
|||||||
## Unreleased
|
## Unreleased
|
||||||
|
|
||||||
- **Breaking:** a list whose bullet character or ordered delimiter changes reads as two lists, as
|
- **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
|
CommonMark reads it: `- a` then `* b`, `1. a` then `1) b`. `adfToLosslessMarkdown` gives a list
|
||||||
one of its kind the other marker, `* ` or `1)`, in place of the `::listBreak` separator. Convert
|
right after one of its kind the other marker, `* ` or `1)`, in place of the `::listBreak`
|
||||||
stored markdown per `MIGRATION.md`.
|
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`
|
- **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
|
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
|
in `portableMarkdownToAdf`, and markdown known to be strict CommonMark in the new
|
||||||
|
|||||||
@@ -149,12 +149,14 @@ saving what this pair read replaces mentions, attachments and macros with text.
|
|||||||
link or code span is trimmed, carriage returns and null characters are removed, and an empty
|
link or code span is trimmed, carriage returns and null characters are removed, and an empty
|
||||||
paragraph drops.
|
paragraph drops.
|
||||||
- A text node's `content` drops: Atlassian's schema forbids it, so no rendered document shows it.
|
- A text node's `content` drops: Atlassian's schema forbids it, so no rendered document shows it.
|
||||||
|
- A list right after a list of its kind takes the other marker, `* ` or `1)`, since CommonMark
|
||||||
|
starts a new list where the marker changes; a task list counts as a bullet list, `* [x] Done`.
|
||||||
- An ordered list numbered past `999999999` is a bullet list keeping its numbers as text.
|
- An ordered list numbered past `999999999` is a bullet list keeping its numbers as text.
|
||||||
- A task list holding a block other than a task is a bullet list keeping its states as text:
|
- A task list holding a block other than a task is a bullet list keeping its states as text:
|
||||||
`- \[x] Done`.
|
`- \[x] Done`.
|
||||||
- Text that would read as a marker takes a backslash: `==` wherever it could open or close a
|
- Text that would read as a marker takes a backslash: `==` wherever it could open or close a
|
||||||
highlight, `[!…]` opening a quote, and `[x]` or `[ ]` opening any list item, since GitHub reads
|
highlight, `[!…]` opening a quote, `[x]` or `[ ]` opening any list item, since GitHub reads
|
||||||
that marker per item.
|
that marker per item, and asterisks that would read as a rule after a `* ` marker: `* \**`.
|
||||||
- A node read back carries no `localId` except a `taskList`, `taskItem` or `blockTaskItem`, which
|
- A node read back carries no `localId` except a `taskList`, `taskItem` or `blockTaskItem`, which
|
||||||
Atlassian's schema requires one on: each gets a UUID v4 hashed from the whole markdown and its
|
Atlassian's schema requires one on: each gets a UUID v4 hashed from the whole markdown and its
|
||||||
position, the same on every read. Join markdown bound for one document and read it once: the same
|
position, the same on every read. Join markdown bound for one document and read it once: the same
|
||||||
|
|||||||
Reference in New Issue
Block a user