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

# Converters

> UrlConverter, HtmlConverter, and MarkdownConverter — convert URLs and HTML/Markdown to PDF.

All three classes are instantiated with `new` and expose a single async method: `convert(options)` → `Promise<Buffer>`.

## UrlConverter

```typescript theme={null}
import { UrlConverter } from "chromiumly";

const converter = new UrlConverter();
const buffer = await converter.convert({
  url: string;  // required
  // + ConversionOptions (properties, header, footer, wait*, extraHttpHeaders, etc.)
});
```

## HtmlConverter

```typescript theme={null}
import { HtmlConverter } from "chromiumly";

const converter = new HtmlConverter();
const buffer = await converter.convert({
  html: PathLikeOrReadStream;  // required (e.g. path to index.html)
  assets?: { file: PathLikeOrReadStream; name: string }[];
  header?: PathLikeOrReadStream;
  footer?: PathLikeOrReadStream;
  // + other ConversionOptions
});
```

## MarkdownConverter

```typescript theme={null}
import { MarkdownConverter } from "chromiumly";

const converter = new MarkdownConverter();
const buffer = await converter.convert({
  html: PathLikeOrReadStream;   // required
  markdown: PathLikeOrReadStream;  // required
  header?: PathLikeOrReadStream;
  footer?: PathLikeOrReadStream;
  // + other ConversionOptions
});
```

## Shared conversion options

See [Types](/reference/types) for full definitions. Summary:

* **properties** — `PageProperties` (size, margins, landscape, singlePage, etc.)
* **header**, **footer** — path, Buffer, or ReadStream
* **waitDelay**, **waitForSelector**, **waitForExpression**
* **extraHttpHeaders**, **failOnHttpStatusCodes**, **failOnConsoleExceptions**, **failOnResourceHttpStatusCodes**, **ignoreResourceHttpStatusDomains**, **failOnResourceLoadingFailed**, **skipNetworkIdleEvent**, **skipNetworkAlmostIdleEvent**
* **pdfUA**, **metadata**, **cookies**, **downloadFrom**, **webhook**
* **split** — `Split` (mode, span, unify, flatten)
* **userPassword**, **ownerPassword**, **embeds**
* **watermark**, **stamp** — `PdfEngineWatermark` and `PdfEngineStamp` (PDF-engine post-processing)
* **rotate** — `PdfEngineRotate` (PDF-engine page rotation after conversion)

`PathLikeOrReadStream` = `string` (path) | `Buffer` | `ReadStream`.
