@orlarey/marked

A marked plugin that renders markpage's fenced blocks (chart, bda, category, adt, diff, tree) — drop it into any marked pipeline.

Install

npm install @orlarey/marked @orlarey/blocks marked

marked and @orlarey/blocks are peer dependencies (install them alongside).

Usage

import { marked } from 'marked';
import { markpageBlocks } from '@orlarey/marked';
import '@orlarey/blocks/styles.css';

marked.use(markpageBlocks());

const html = marked.parse(`
# Report

\`\`\`chart line "Sales" y-min=0
quarter, revenue
Q1, 12
Q2, 19
\`\`\`
`);

Wrap the rendered HTML in an element with the markpage class so the styles from @orlarey/blocks/styles.css apply:

<article class="markpage">${html}</article>

Behaviour

• Overrides marked's fenced-code renderer. A fence whose language is a registered block (chart, …) is rendered by @orlarey/blocks; every other fence falls through to marked's default (syntax highlighting, etc.) untouched.
• markpage's richer document features (captions / cross-references, math, the running header/footer, paginated PDF) are not part of this plugin — it only renders the standalone block fences. For the full experience, use the markpage app.

Fence syntax

The body and options of each fence (chart, bda, category, adt, diff, tree) are documented in @orlarey/blocks's SYNTAX.md — it ships in the @orlarey/blocks peer dependency, so it's also available offline at node_modules/@orlarey/blocks/SYNTAX.md.

Caption / figure numbering

Pass markpageBlocks({ captions: false }) to skip the auto-numbered <figure> wrapper, or { labels: { figure: 'Figure', listing: 'Listing' } } to localise the caption words. Numbering resets per marked.parse() call.

Peer dependencies

marked (>= 12) and @orlarey/blocks.