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

Copy the README tagline to the npm description at publish; name Jira and Confluence in it

This commit is contained in:
2026-11-08 10:52:48 +01:00
committed by Lillem4n
parent db243b6d73
commit c3f10b5175
7 changed files with 65 additions and 3 deletions
+6 -2
View File
@@ -3,8 +3,10 @@
[![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 between ADF (Atlassian Document Format) and markdown or HTML. For application developers
whose app shows, edits, exports or generates the rich text Atlassian products store as ADF.
Convert between ADF (Atlassian Document Format, the rich text of Jira and Confluence) and markdown or HTML.
For application developers whose app shows, edits, exports or generates the rich text Atlassian
products store as ADF.
## Main functionality
@@ -784,6 +786,8 @@ All three commands need only Docker, git and bash 5.
- `./mutation-tests/run.sh [<base>]` mutation-tests the lines changed since `<base>`, `origin/main`
by default, in source files git tracks. It needs 6 GB of memory for Docker, and lists the mutants
that survived. Survivors don't fail it; a mutant whose test run crashed does.
- The README's first paragraph after the badges is the npm description: `./publish.sh` copies it to
`package.json`. Keep it plain text; `./ci.sh` fails where it isn't.
## Links