3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-12 11:48:29 +01:00

Answer prose round 2: 0 🔴, 2 🟡 (0 misread); the opening splits where it runs from who it is for, the changelog names both tables

This commit is contained in:
2026-10-28 21:17:58 +01:00
committed by Lillem4n
parent 3616c78ea2
commit d02077ae04
2 changed files with 12 additions and 7 deletions
+3 -2
View File
@@ -4,8 +4,9 @@
- The package's description and keywords say it needs no React, Atlaskit or runtime dependency and
runs in Node, Forge, Deno, Bun and browsers, and the README opens with the call to take for each
need. The README's comparison table lists every npm package that runs in Node and converts ADF to or
from markdown, and other ecosystems' libraries and Atlassian's own paths.
need. The README's first comparison table lists the npm packages running in Node that convert ADF
to or from markdown and work, wrappers and forks aside; its second table lists other ecosystems'
libraries and Atlassian's own paths.
- `adfToHtml` writes ADF as HTML: paragraphs, headings, lists, quotes, code blocks, rules, hard
breaks, a centered, uncaptioned external image holding no attribute but its URL and alt, and `em`,
`strong`, `code` and links as their elements. A paragraph, heading, quote, list, list item, code block or
+9 -5
View File
@@ -7,8 +7,10 @@ Convert Atlassian Document Format (ADF), the rich text of Jira and Confluence, t
with a lossless round-trip, and to HTML.
This package is pure functions with no React, no Atlaskit and no runtime dependencies, and nothing to
configure or connect. It runs in Node, Forge, Deno, Bun and browsers, and is for application
developers whose app shows, edits, exports or generates the rich text Atlassian products store as ADF.
configure or connect. It runs in Node, Forge, Deno, Bun and browsers.
It is for application developers whose app shows, edits, exports or generates the rich text Atlassian
products store as ADF.
| You have | You want | Take | What it does |
| --- | --- | --- | --- |
@@ -17,8 +19,8 @@ developers whose app shows, edits, exports or generates the rich text Atlassian
| ADF | markdown that GitHub, GitLab and Obsidian render | `adfToPortableMarkdown` | keeps the text, images by URL and link targets and drops the rest |
| ADF | HTML | `adfToHtml` | writes paragraphs, headings, lists, quotes, code blocks, rules, breaks, a plain external image, links, and code, emphasis and strong text as HTML elements, and every other node as an element holding its JSON; `htmlToAdf` reads that HTML back to the same document, and refuses any other HTML |
Every call returns a result, never a throw. A refusal carries a code from a closed list, and the same input
gets the same refusal, except for `engine-limit` ([The guarantees](#the-guarantees)).
Every call returns a result, never a throw. A refusal carries a code from a closed list, and the same input gets the same refusal, except
for `engine-limit` ([The guarantees](#the-guarantees)).
TypeScript types ship beside the JavaScript.
Atlaskit's markdown transformer converts markdown to ADF, and its ADF to markdown throws.
@@ -249,7 +251,9 @@ or from markdown and is reasonably complete and works, whatever its downloads. `
`md-to-adf` and `@wrtnlabs/markdown-to-adf` are left out because they get an ordinary quote, list or
document wrong; a wrapper or fork of a listed package is left out too. The list comes from npm
searches on 2026-10-28 for "adf markdown", "markdown to adf", "adf to markdown", "atlassian document
format" and "adf converter". On 2026-10-28, [`converter-comparison/`](https://github.com/larvit/adf-codec/tree/main/converter-comparison)
format" and "adf converter".
On 2026-10-28, [`converter-comparison/`](https://github.com/larvit/adf-codec/tree/main/converter-comparison)
ran each package's published code, at the version the table names, with its default options. A
package writing markdown got a document holding marks, a link, a mention, a status, a panel and a
list, and a document holding a node type it cannot know. A package reading markdown got markdown