# Nuxt PDF

> Author and render PDFs with Vue components in Nuxt.

## When to use

Use this site to author and render PDF documents with Nuxt PDF.

## Documentation

- [Overview](https://nuxt-pdf.lupinum.com/raw/docs/getting-started.md): Decide whether Nuxt PDF fits the document you need to create.
- [Install Nuxt PDF](https://nuxt-pdf.lupinum.com/raw/docs/getting-started/installation.md): Add server-side PDF rendering to an existing Nuxt 4 application.
- [Render your first PDF](https://nuxt-pdf.lupinum.com/raw/docs/getting-started/quickstart.md): Create, download, and preview a small invoice in a Nuxt application.
- [Templates and the registry](https://nuxt-pdf.lupinum.com/raw/docs/learn/templates-and-registry.md): How files under pdfs become typed server-side render functions.
- [The document tree](https://nuxt-pdf.lupinum.com/raw/docs/learn/document-tree.md): PDF primitives, valid nesting, Vue composition, and dynamic text.
- [Styling and layout](https://nuxt-pdf.lupinum.com/raw/docs/learn/styling-and-layout.md): The PDF style model, flex layout, units, inheritance, and shared geometry.
- [Runtime and data loading](https://nuxt-pdf.lupinum.com/raw/docs/learn/runtime-and-data.md): Where PDF templates execute and how data enters a render.
- [Build reusable document components](https://nuxt-pdf.lupinum.com/raw/docs/guides/reusable-components.md): Organize repeated PDF sections without creating a second component system.
- [Add images and fonts](https://nuxt-pdf.lupinum.com/raw/docs/guides/images-and-fonts.md): Bundle local PNG, JPEG, TTF, OTF, and WOFF2 resources with a PDF template.
- [Configure remote images](https://nuxt-pdf.lupinum.com/raw/docs/guides/remote-images.md): Admit specific HTTPS image paths and understand the request boundary.
- [Add links, bookmarks, and a table of contents](https://nuxt-pdf.lupinum.com/raw/docs/guides/contents-links-bookmarks.md): usePdfPageNumbers, the multi-pass layout loop, convergence and maxPasses, internal links, and the bookmark outline.
- [Draw SVG graphics](https://nuxt-pdf.lupinum.com/raw/docs/guides/svg-graphics.md): The SVG primitive set, direct presentation props, scoped definitions, SVG text, and the supported numeric boundary.
- [Test a PDF](https://nuxt-pdf.lupinum.com/raw/docs/guides/testing.md): Assert against your own templates with a real render using @lupinum/nuxt-pdf/test, plus a realistic Vitest example.
- [Diagnose render failures](https://nuxt-pdf.lupinum.com/raw/docs/guides/errors-and-debugging.md): Use template attribution, preview diagnostics, and exact error messages to recover from a failed render.
- [Deploy and operate](https://nuxt-pdf.lupinum.com/raw/docs/guides/deployment.md): Size, cache, queue, and monitor PDF rendering on a tested Node target.
- [Production recipes](https://nuxt-pdf.lupinum.com/raw/docs/guides/recipes.md): Copyable Vue patterns for invoices, statements, reports, repeating matter, and payment QR codes.
- [Render outside Nitro](https://nuxt-pdf.lupinum.com/raw/docs/guides/standalone-node.md): Compile PDF templates once and render the generated registry in a Node worker.
- [Module options](https://nuxt-pdf.lupinum.com/raw/docs/reference/module-options.md): Build-time configuration for registered fonts, remote images, and render budgets.
- [definePdf](https://nuxt-pdf.lupinum.com/raw/docs/reference/define-pdf.md): The compile-time definition for render metadata, development preview data, and the multi-pass limit.
- [Registry and render result](https://nuxt-pdf.lupinum.com/raw/docs/reference/registry.md): The typed #pdf server module, runtime dispatch, and completed render conversions.
- [Primitives](https://nuxt-pdf.lupinum.com/raw/docs/reference/primitives.md): Prop tables for every document and SVG primitive, drawn from the shipped type definitions.
- [Styles](https://nuxt-pdf.lupinum.com/raw/docs/reference/styles.md): Accepted style keys, values, units, inheritance, and primitive support.
- [Page sizes](https://nuxt-pdf.lupinum.com/raw/docs/reference/page-sizes.md): Named and custom page dimensions accepted by PdfPage.
- [Composables](https://nuxt-pdf.lupinum.com/raw/docs/reference/composables.md): The auto-imported usePdfPageNumbers map that activates multi-pass layout.
- [Errors and limits](https://nuxt-pdf.lupinum.com/raw/docs/reference/errors-and-limits.md): Error classes, exact codes, render-budget defaults, and when each failure occurs.
- [Test utilities](https://nuxt-pdf.lupinum.com/raw/docs/reference/test-utilities.md): The render, parse, assert, and snapshot exports of @lupinum/nuxt-pdf/test.
- [Standalone build and runtime](https://nuxt-pdf.lupinum.com/raw/docs/reference/standalone.md): Production registry generation and Node runtime exports outside Nitro.
- [Example gallery](https://nuxt-pdf.lupinum.com/raw/docs/examples.md): Six playground templates and the technique that each template demonstrates.
- [Supported behavior and limitations](https://nuxt-pdf.lupinum.com/raw/docs/examples/supported-behavior.md): The public compatibility boundary and where to find its executable evidence.