From c66cbc288b2275b1c427f7c5b314ee59a990cbe5 Mon Sep 17 00:00:00 2001 From: Lilleman auf Larv Date: Fri, 9 Oct 2026 12:53:49 +0200 Subject: [PATCH] Describe only markdown in the package description and the README's tagline --- CHANGELOG.md | 2 +- README.md | 2 +- package.json | 3 +-- todo.md | 6 ------ 4 files changed, 3 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d0cd693..c0e3a13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,7 +15,7 @@ keys. Build it as JSON holds it: `date.toISOString()`, `Object.fromEntries(map)`, `Array.from(bytes)`, `{ ...instance }`. - The README opens with what the package does and for whom, and `package.json` carries search - keywords. + keywords. Both describe markdown alone until HTML lands at `0.3.0`. - The source moves to [github.com/larvit/adf-codec](https://github.com/larvit/adf-codec), where issues and pull requests go. - **Breaking:** directives, the inline opaque carry among them (now `!adf:carry{json="…"}`), are diff --git a/README.md b/README.md index eec4dac..893d11e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![npm](https://img.shields.io/npm/v/@larvit/adf-codec)](https://www.npmjs.com/package/@larvit/adf-codec) [![CI](https://github.com/larvit/adf-codec/actions/workflows/ci.yml/badge.svg)](https://github.com/larvit/adf-codec/actions/workflows/ci.yml) -Convert Atlassian Document Format (ADF) to and from markdown and HTML, with a lossless round-trip. +Convert Atlassian Document Format (ADF) to and from markdown, with a lossless round-trip. For application developers whose app shows, edits, exports or generates the rich text Atlassian products store as ADF. diff --git a/package.json b/package.json index d9a3c6d..1ce4adf 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@larvit/adf-codec", "version": "0.1.0", - "description": "Convert Atlassian Document Format (ADF) to and from markdown and HTML, with a lossless round-trip.", + "description": "Convert Atlassian Document Format (ADF) to and from markdown, with a lossless round-trip.", "keywords": [ "adf", "atlassian", @@ -9,7 +9,6 @@ "commonmark", "confluence", "converter", - "html", "jira", "markdown", "typescript" diff --git a/todo.md b/todo.md index db0c4a7..5f9504c 100644 --- a/todo.md +++ b/todo.md @@ -25,7 +25,6 @@ | ID | Release | Exempt | Item | R | S | A | G | Goals | Score | |---|---|---|---|---|---|---|---|---|---| -| 90 | 0.2.0 | | **Describe only the formats the release converts in `package.json`'s description and the README's tagline.** | 1 | 1 | 6 | 7 | 3 | 21.7 | | 88 | 0.2.0 | defect | **Build a `blockTaskItem` holding only the paragraphs and extensions Atlassian's schema allows, in `portableMarkdownToAdf`.** | 4 | 4 | 6 | 7 | 4 | 16.4 | | 49 | 0.2.0 | | **Read a list whose bullet or ordered delimiter changes as two lists, in every reader, and retire `!adf:listBreak`.** | 4 | 5 | 5 | 8 | 4, 5 | 15.5 | | 61 | 0.2.0 | decision | **Have the emitter ask the inline reader how a line reads back, in place of `line-escaping.ts` predicting it.** | 6 | 8 | 3 | 8 | 1 | 14.0 | @@ -69,11 +68,6 @@ ## Details -### 90. Describe only the formats the release converts in `package.json`'s description and the README's tagline. - -Both say "to and from markdown and HTML", and `0.2.0` ships no HTML (item 7 brings it in `0.3.0`): -`docs/decisions.md` §Docs describe the release being built. - ### 88. Build a `blockTaskItem` holding only the paragraphs and extensions Atlassian's schema allows, in `portableMarkdownToAdf`. `- [x] done\n\n ![a](u)` builds a `blockTaskItem` holding a `mediaSingle`, and `- [x] done\n\n > q`