Registry / serialization / extended-markdown-adf-parser

extended-markdown-adf-parser

library2.4.0jsnpmunverified

A bidirectional parser v2.4.0 for converting between Atlassian Document Format (ADF) and Extended Markdown. Released under MIT license with monthly updates, it supports all major ADF elements including panels, expands, media, tables, status, emoji, mentions, dates, and code blocks. Key differentiators: advanced nested processing via multi-pass parsing, metadata annotation for full fidelity, zero runtime dependencies, dual CJS/ESM module support, and 100% test coverage. Requires Node >=20.11.1 and ships TypeScript types.

serialization

npm install extended-markdown-adf-parser

github ↗package ↗

INSTALL

IMPORT

SIG · EXTENDED-MARKDOWN-

extended-markdown-adf-parser

serializationjavascriptv2.4.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

parseAdfToMarkdown

✓ import { parseAdfToMarkdown } from 'extended-markdown-adf-parser'

✗ const parseAdfToMarkdown = require('extended-markdown-adf-parser').parseAdfToMarkdown

Default function exported as named export, not default. ESM and CJS both supported since v1.1.0.

parseMarkdownToAdf

✓ import { parseMarkdownToAdf } from 'extended-markdown-adf-parser'

✗ import parseMarkdownToAdf from 'extended-markdown-adf-parser'

Named export only. Default export is not provided.

Parser

✓ import { Parser } from 'extended-markdown-adf-parser'

✗ const Parser = require('extended-markdown-adf-parser').Parser

Class export, available as named export in both ESM and CJS. TypeScript type definitions included.

ExtendedMarkdownParser

✓ import { ExtendedMarkdownParser } from 'extended-markdown-adf-parser'

✗ import ExtendedMarkdownParser from 'extended-markdown-adf-parser'

Named export for advanced parsing with multi-pass processing. Only in v2.2.0+.

Shows bidirectional conversion between Extended Markdown and Atlassian Document Format, including panels and expands.

import { parseAdfToMarkdown, parseMarkdownToAdf } from 'extended-markdown-adf-parser'; // Extended Markdown string const markdown = `# Hello World This is a paragraph with **bold** and *italic* text. {info}A note panel{info} {expand:Expandable Section} Content inside the expand block. {expand} `; // Convert to ADF const adf = parseMarkdownToAdf(markdown); console.log(JSON.stringify(adf, null, 2)); // Convert back to Markdown const markdownAgain = parseAdfToMarkdown(adf); console.log(markdownAgain);

Debug

Known issues

breakingv2.3.0 replaced performance monitor with browser-compatible implementation, removing process.memoryUsage(). Code relying on that functionality will break.

fix

Upgrade to v2.3.0+ or remove custom performance monitoring calls.

affects: <2.3.0

deprecatedparseAdfToMarkdown and parseMarkdownToAdf are the preferred imports over Parser class since v2.0.0. Using Parser will still work but may be removed in future major version.

fix

Replace Parser usage with named function imports.

affects: >=2.0.0

gotchaExtended Markdown syntax uses non-standard extensions like {info}, {expand}, and {status}. Standard Markdown parsers will not render these correctly.

fix

Use this library for both parsing and rendering, or convert to ADF first and use Atlassian renderer.

affects: >=1.0.0

gotchaEmoji short names must include colons (e.g., :grinning:) in v2.2.0+; older v1.x required no colons.

fix

Use colon-enclosed short names like :grinning: instead of grinning.

affects: >=2.2.0

deprecatedStatus element color attribute changed in v2.3.1: 'style' attribute removed in favor of 'color' with official Atlassian color names.

fix

Use color:green|red|yellow|blue|purple in status syntax instead of style attribute.

affects: >=2.3.1

breakingv2.2.0 introduced multi-pass nested processing which changed the internal API of ExtendedMarkdownParser. Custom implementations depending on earlier pass logic may break.

fix

Update any custom parser extensions to use the new multi-pass API.

affects: <2.2.0

gotchaThe package requires Node.js >=20.11.1. Older Node versions will fail to install or run.

fix

Upgrade Node.js to v20.11.1+.

affects: >=2.0.0

Errors

Common errors & fixes

TypeError: process.memoryUsage is not a function

Using v2.2.x or earlier in browser environment (React, Vite, etc.) due to Node-specific API.

fix

Upgrade to v2.3.0+ which removes performance monitor dependencies.

SyntaxError: Named export 'parseAdfToMarkdown' not found. The requested module 'extended-markdown-adf-parser' is a CommonJS module.

Using named ESM imports with a CJS module in older versions without proper dual module support.

fix

Upgrade to v1.1.0+ which provides dual CJS/ESM support; ensure bundler is configured correctly.

ValidationError: Unknown attribute 'style' in node type 'status'

Using deprecated 'style' attribute in status syntax after v2.3.1.

fix

Use official 'color' attribute with valid color names: neutral, green, red, yellow, blue, purple.

Error: Node.js version must be >=20.11.1

Attempting to install or run on a Node.js version below the required minimum.

fix

Install or switch to Node.js v20.11.1 or higher using nvm or similar.

Upgrade

Version history

2.4.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

Bingbot

Resources

githubhttps://github.com/JeromeErasmus/extended-markdown-adf-parser ↗

packagehttps://www.npmjs.com/package/extended-markdown-adf-parser ↗