Getting started

Usage

Render PDF bytes with renderPdf, export files on Node, and preview in the browser.

Render to PDF bytes

import { renderPdf, createPdfRenderer } from 'comark-pdf'
import { writeFile } from 'node:fs/promises'

// One-shot
const bytes = await renderPdf(`
---
pdf:
  format: A4
  margin: 20mm
  footer: "Page {{ page }} of {{ totalPages }}"
---

# My Document

Content here.

::page-break
::

# Chapter 2

More content.
`)

await writeFile('output.pdf', bytes)

// Reusable renderer (parser initialized once)
const render = createPdfRenderer({
  pdf: { format: 'A4', margin: '20mm', footer: 'Page {{ page }} of {{ totalPages }}' },
})
const bytes2 = await render(markdownString)

renderPdf(), createPdfRenderer(), and the Node helpers accept PdfRendererOptions.

Node.js file export

import { renderPdfToBuffer, renderPdfToFile } from 'comark-pdf/node'

const buffer = await renderPdfToBuffer(markdown)
await writeFile('output.pdf', buffer)

// Or write directly to a file
await renderPdfToFile(markdown, 'output.pdf')

Browser preview

import { renderPdf } from 'comark-pdf'
import { mount } from 'comark-pdf/preview'

const bytes = await renderPdf(markdownString)
const handle = mount(document.getElementById('preview'), bytes)

// Later, to free the Blob URL:
handle.revoke()

See Browser preview for mount options and cleanup.

Batch labels with each

Render the body once per entry, with a page break between entries. Each entry merges over data:

const bytes = await renderPdf('# {{ data.row.code }}', {
  pdf: { width: '50.8mm', height: '50.8mm', margin: '2mm' },
  data: { organization: 'Acme' },
  each: rows.map(row => ({ row })),
})

Use it for label batches — one label per page.

Copyright © 2026