> ## 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.

# SDK reference overview

> Public exports and structure of the Chromiumly TypeScript library.

Chromiumly is a TypeScript library that runs on **Node.js**, **Deno**, and **Bun**. It does not expose a REST API; you use the SDK in your application to call Gotenberg (or the hosted API).

## Main exports

From the default entry point (`chromiumly`):

| Export               | Description                                                                                                              |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `Chromiumly`         | Config class: `configure()`, endpoint/API key resolution                                                                 |
| `System`             | System routes: health checks, version, debug, and metrics                                                                |
| `UrlConverter`       | Convert URL → PDF                                                                                                        |
| `HtmlConverter`      | Convert HTML file → PDF                                                                                                  |
| `MarkdownConverter`  | Convert HTML + Markdown → PDF                                                                                            |
| `UrlScreenshot`      | Capture URL → image (PNG/JPEG/WebP)                                                                                      |
| `HtmlScreenshot`     | Capture HTML file → image                                                                                                |
| `MarkdownScreenshot` | Capture HTML + Markdown → image                                                                                          |
| `LibreOffice`        | Convert office documents → PDF (static `convert()`)                                                                      |
| `PDFEngines`         | Merge, split, rotate, flatten, convert to PDF/A, read/write metadata, read/write bookmarks, encrypt, embed, `generate()` |
| `Templates`          | Hosted template generation (`generate()`) for invoice PDFs                                                               |
| `PdfFormat`          | Enum: `PdfFormat.A_1a`, `A_2b`, `A_3b` (PDF/A)                                                                           |

## Usage pattern

```typescript theme={null}
import { Chromiumly, UrlConverter, PDFEngines, PdfFormat } from "chromiumly";

// Configure once (or use env)
Chromiumly.configure({ apiKey: "..." }); // or { endpoint: "http://localhost:3000" }

// Convert
const urlConverter = new UrlConverter();
const buffer = await urlConverter.convert({ url: "https://example.com/" });

// Optional: write to __generated__/out.pdf
await PDFEngines.generate("out.pdf", buffer);
```

## Reference pages

* [Chromiumly](/reference/chromiumly) — `configure()` and config options
* [System](/reference/system) — health, version, debug, and metrics routes
* [Converters](/reference/converters) — `UrlConverter`, `HtmlConverter`, `MarkdownConverter`
* [Screenshots](/reference/screenshots) — `UrlScreenshot`, `HtmlScreenshot`, `MarkdownScreenshot`
* [LibreOffice](/reference/libreoffice) — `LibreOffice.convert()`
* [PDFEngines](/reference/pdf-engines) — merge, split, rotate, flatten, convert, metadata, bookmarks, encrypt, embed, generate
* [Types](/reference/types) — `PageProperties`, `ConversionOptions`, `ImageProperties`, `PdfFormat`, `Split`, `PdfEngineRotate`, etc.
* [Templates guide](/advanced/templates) — hosted `Templates.generate()` and request shape