Skip to main content
Chromiumly wraps Gotenberg’s Chromium routes for conversion and screenshot routes for images. Conversion works by simulating browser navigation (URL route) or rendering files you send (HTML/Markdown routes): Chromium loads the page, runs JavaScript, loads CSS and assets, then captures the DOM as PDF. Inputs can be a file path, a Buffer, or a ReadStream. For server configuration and limits, see Gotenberg’s Chromium docs.

​
Converters (to PDF)

ClassInputMethod
UrlConverterURL stringconvert({ url })
HtmlConverterHTML file (e.g. index.html)convert({ html })
MarkdownConverterHTML + Markdown filesconvert({ html, markdown })
Each convert() returns a Buffer containing the PDF. Pass page properties (size, margins, landscape, etc.) and options like headers, wait conditions, and PDF encryption.

​
Screenshots (to PNG/JPEG/WebP)

ClassInputMethod
UrlScreenshotURL stringcapture({ url })
HtmlScreenshotHTML filecapture({ html })
MarkdownScreenshotHTML + Markdown filescapture({ html, markdown })
Each capture() returns a Buffer (image). Set format, quality, dimensions, and similar options via screenshot options.

​
Next pages

  • URL — convert a URL to PDF or capture a screenshot
  • HTML — convert or capture from an HTML file
  • Markdown — convert or capture from HTML + Markdown
  • Options — page properties, conversion options, and screenshot options