https://github.com/sidebase/nuxt-pdf

📄 A easy to use, pdf exporting module to convert Nuxt 3 components into downloadable PDFs.
https://github.com/sidebase/nuxt-pdf

nuxt pdf-export typescript

Last synced: about 2 months ago
JSON representation

📄 A easy to use, pdf exporting module to convert Nuxt 3 components into downloadable PDFs.

• Host: GitHub
• URL: https://github.com/sidebase/nuxt-pdf
• Owner: sidebase
• License: mit
• Created: 2023-01-04T09:33:01.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-13T09:43:48.000Z (4 months ago)
• Last Synced: 2024-06-27T07:36:26.536Z (3 months ago)
• Topics: nuxt, pdf-export, typescript
• Language: TypeScript
• Homepage: https://sidebase.io/nuxt-pdf/getting-started
• Size: 718 KB
• Stars: 101
• Watchers: 2
• Forks: 11
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![nuxt-pdf](.github/preview.jpg)

# 📄 nuxt-pdf

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![GitHub stars](https://badgen.net/github/stars/sidebase/nuxt-pdf)](https://GitHub.com/sidebase/nuxt-pdf/)

[![License][license-src]][license-href]

[![Follow us on Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/sidebase_io)

[![Join our Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/NDDgQkcv3s)

> `nuxt-pdf` is a easy to use, pdf exporting module to convert Nuxt 3 components into downloadable PDFs.

## Features

- Easily export your Nuxt 3 components into PDFs

- Generate PDFs on your server

- Guides for PDF specific styles

- Track exporting progress

## Quick Setup

1. Add `@sidebase/nuxt-pdf` dependency to your project

```bash

# Using pnpm

pnpm add -D @sidebase/nuxt-pdf

# Using yarn

yarn add --dev @sidebase/nuxt-pdf

# Using npm

npm install --save-dev @sidebase/nuxt-pdf

```

2. Add `@sidebase/nuxt-pdf` to the `modules` section of `nuxt.config.ts`

```js

export default defineNuxtConfig({

  modules: [

    '@sidebase/nuxt-pdf'

  ]

})

```

That's it! You can now use NuxtPDF in your Nuxt 3 app ✨

Afterwards you can use the [Quick Start documentation](https://sidebase.io/nuxt-pdf/getting-started/quick-start) to explore the features and properly configure your NuxtPDF instance!

## Development

```bash

# Install dependencies

pnpm install

# Generate type stubs

pnpm run dev:prepare

# Develop with the playground

pnpm run dev

# Build the playground

pnpm run dev:build

# Run ESLint

pnpm run lint

# Publish a new release (bump version before)

pnpm publish --access public

```

[npm-version-src]: https://img.shields.io/npm/v/@sidebase/nuxt-pdf/latest.svg

[npm-version-href]: https://npmjs.com/package/@sidebase/nuxt-pdf

[npm-downloads-src]: https://img.shields.io/npm/dt/@sidebase/nuxt-pdf.svg

[npm-downloads-href]: https://npmjs.com/package/@sidebase/nuxt-pdf

[license-src]: https://img.shields.io/npm/l/@sidebase/nuxt-pdf.svg

[license-href]: https://npmjs.com/package/@sidebase/nuxt-pdf