# Chromiumly

> Documentation for Chromiumly — a TypeScript library that interacts with Gotenberg to convert documents to PDF.

## Docs

- [Embedding files in PDFs](https://docs.chromiumly.dev/advanced/embedding.md): Attach files to generated PDFs for ZUGFeRD, Factur-X, or other use cases.
- [PDF encryption](https://docs.chromiumly.dev/advanced/encryption.md): Protect PDFs with user and owner passwords using userPassword and ownerPassword.
- [Templates (hosted API)](https://docs.chromiumly.dev/advanced/templates.md): Generate invoice PDFs from structured data with the hosted Templates API.
- [Authentication](https://docs.chromiumly.dev/authentication.md): API key, basic auth, and custom HTTP headers for Chromiumly and Gotenberg.
- [HTML conversion and screenshots](https://docs.chromiumly.dev/chromium/html.md): Convert an HTML file to PDF or capture a screenshot with HtmlConverter and HtmlScreenshot.
- [Markdown conversion and screenshots](https://docs.chromiumly.dev/chromium/markdown.md): Convert HTML plus Markdown to PDF or capture a screenshot with MarkdownConverter and MarkdownScreenshot.
- [Chromium options](https://docs.chromiumly.dev/chromium/options.md): Page properties, conversion options, and screenshot options for Chromium routes.
- [Chromium overview](https://docs.chromiumly.dev/chromium/overview.md): Convert URLs, HTML, and Markdown to PDF or capture them as screenshots using Gotenberg's Chromium routes.
- [URL conversion and screenshots](https://docs.chromiumly.dev/chromium/url.md): Convert a URL to PDF or capture a full-page screenshot with UrlConverter and UrlScreenshot.
- [Configuration](https://docs.chromiumly.dev/configuration.md): Set the Gotenberg endpoint or hosted API key via environment variables or code.
- [Introduction](https://docs.chromiumly.dev/index.md): Chromiumly is a lightweight TypeScript library that interacts with Gotenberg to convert documents to PDF.
- [Installation](https://docs.chromiumly.dev/installation.md): Install Chromiumly and set up prerequisites for hosted or self-hosted use.
- [LibreOffice](https://docs.chromiumly.dev/libreoffice.md): Convert office documents (DOCX, XLSX, PPTX, etc.) to PDF using Gotenberg's LibreOffice route.
- [Format conversion](https://docs.chromiumly.dev/pdf-engines/convert.md): Convert PDFs to PDF/A and PDF/UA with PDFEngines.convert.
- [Flatten PDFs](https://docs.chromiumly.dev/pdf-engines/flatten.md): Flatten forms and annotations into static content with PDFEngines.flatten.
- [Merge PDFs](https://docs.chromiumly.dev/pdf-engines/merge.md): Merge multiple PDF files into one with PDFEngines.merge.
- [Metadata](https://docs.chromiumly.dev/pdf-engines/metadata.md): Read and write PDF metadata and bookmarks with PDFEngines.
- [PDF engines overview](https://docs.chromiumly.dev/pdf-engines/overview.md): Convert to PDF/A and PDF/UA, merge, watermark/stamp, read/write metadata and bookmarks, split, rotate, and flatten PDFs with PDFEngines.
- [Rotate PDFs](https://docs.chromiumly.dev/pdf-engines/rotate.md): Rotate PDF pages with PDFEngines.rotate or the rotate option on merge, split, and converters.
- [Split PDFs](https://docs.chromiumly.dev/pdf-engines/split.md): Split PDFs by page ranges or intervals with PDFEngines.split or the split option on Chromium/LibreOffice.
- [Watermark and stamp](https://docs.chromiumly.dev/pdf-engines/watermark-stamp.md): Apply PDF-engine watermark and stamp overlays with PDFEngines.
- [Quickstart](https://docs.chromiumly.dev/quickstart.md): Minimal setup to convert a URL to PDF with Chromiumly.
- [Chromiumly](https://docs.chromiumly.dev/reference/chromiumly.md): Configuration API: Chromiumly.configure() and endpoint resolution.
- [Converters](https://docs.chromiumly.dev/reference/converters.md): UrlConverter, HtmlConverter, and MarkdownConverter — convert URLs and HTML/Markdown to PDF.
- [LibreOffice](https://docs.chromiumly.dev/reference/libreoffice.md): LibreOffice.convert() — convert office documents to PDF.
- [SDK reference overview](https://docs.chromiumly.dev/reference/overview.md): Public exports and structure of the Chromiumly TypeScript library.
- [PDFEngines](https://docs.chromiumly.dev/reference/pdf-engines.md): Static methods for convert, merge, split, rotate, watermark, stamp, metadata, bookmarks, flatten, encrypt, embed, and generate.
- [Screenshots](https://docs.chromiumly.dev/reference/screenshots.md): UrlScreenshot, HtmlScreenshot, and MarkdownScreenshot — capture full-page images.
- [System](https://docs.chromiumly.dev/reference/system.md): Static methods for Gotenberg system endpoints: health, version, debug, and metrics.
- [Types](https://docs.chromiumly.dev/reference/types.md): PageProperties, ConversionOptions, ImageProperties, PdfFormat, Split, and other shared types.

## OpenAPI Specs

- [openapi](https://docs.chromiumly.dev/api-reference/openapi.json)