@sidebase/nuxt-pdf

📄 nuxt-pdf

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

# 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

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 to explore the features and properly configure your NuxtPDF instance!

Development

# 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