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

# Introduction

> Chromiumly is a lightweight TypeScript library that interacts with Gotenberg to convert documents to PDF.

Chromiumly integrates with [Gotenberg](https://gotenberg.dev/) 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](https://gotenberg.dev/docs/).

## Hosted API vs self-hosted

<Tip title="Recommended">
  Use the **hosted API** with an API key: sign up at [chromiumly.dev](https://chromiumly.dev), set `CHROMIUMLY_API_KEY` or `Chromiumly.configure({ apiKey: "..." })`, and start converting. No Docker or server to run.
</Tip>

| Option          | Use when                                                                                                                                                              |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Hosted API**  | Recommended. No Docker or server management. Set `CHROMIUMLY_API_KEY` or call `Chromiumly.configure({ apiKey: "..." })`. Requests go to `https://api.chromiumly.dev`. |
| **Self-hosted** | You run [Gotenberg](https://gotenberg.dev/) (e.g. via Docker). Set `GOTENBERG_ENDPOINT` or call `Chromiumly.configure({ endpoint: "http://localhost:3000" })`.        |

<Card title="Quickstart" icon="rocket" href="/quickstart" horizontal>
  Install the package and run a minimal URL-to-PDF conversion.
</Card>

<Columns cols={2}>
  <Card title="Configuration" icon="gear" href="/configuration">
    Configure the endpoint or API key (hosted vs self-hosted).
  </Card>

  <Card title="Chromium" icon="file-code" href="/chromium/overview">
    Convert URLs, HTML, and Markdown to PDF; capture screenshots.
  </Card>

  <Card title="LibreOffice" icon="file-lines" href="/libreoffice">
    Convert office documents (DOCX, XLSX, PPTX, etc.) to PDF.
  </Card>

  <Card title="PDF engines" icon="file-pdf" href="/pdf-engines/overview">
    Merge, split, flatten, and convert to PDF/A or PDF/UA.
  </Card>
</Columns>

## SDK reference

The library exports converters, screenshot classes, `LibreOffice`, and `PDFEngines`. See the [Reference](/reference/overview) tab for class and type details.