Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chromiumly.dev/llms.txt

Use this file to discover all available pages before exploring further.

Chromiumly integrates with Gotenberg to convert URLs, HTML, Markdown, and office documents to PDF, and runs on Node.js, Deno, and Bun. Use the hosted API at api.chromiumly.dev with an API key, or run Gotenberg yourself (self-hosted).

​
What you can do

  • Chromium: Convert URLs, HTML, and Markdown to PDF; capture full-page screenshots as PNG, JPEG, or WebP.
  • LibreOffice: Convert DOCX, XLSX, PPTX, and other office formats to PDF.
  • PDF engines: Convert to PDF/A and PDF/UA, merge PDFs, read/write metadata, split, flatten, and more.
Chromiumly wraps Gotenberg’s API; for server-side configuration, limits, and troubleshooting, see Gotenberg’s documentation.

​
Hosted API vs self-hosted

Use the hosted API with an API key: sign up at chromiumly.dev, set CHROMIUMLY_API_KEY or Chromiumly.configure({ apiKey: "..." }), and start converting. No Docker or server to run.
OptionUse when
Hosted APIRecommended. No Docker or server management. Set CHROMIUMLY_API_KEY or call Chromiumly.configure({ apiKey: "..." }). Requests go to https://api.chromiumly.dev.
Self-hostedYou run Gotenberg (e.g. via Docker). Set GOTENBERG_ENDPOINT or call Chromiumly.configure({ endpoint: "http://localhost:3000" }).

Quickstart

Install the package and run a minimal URL-to-PDF conversion.

Configuration

Configure the endpoint or API key (hosted vs self-hosted).

Chromium

Convert URLs, HTML, and Markdown to PDF; capture screenshots.

LibreOffice

Convert office documents (DOCX, XLSX, PPTX, etc.) to PDF.

PDF engines

Merge, split, flatten, and convert to PDF/A or PDF/UA.

​
SDK reference

The library exports converters, screenshot classes, LibreOffice, and PDFEngines. See the Reference tab for class and type details.