Overview
Nuxt PDF is a tool that allows users to generate PDF files directly from the content on their website. It can be used to create offline downloadable documentation pages. The project is currently looking for a new maintainer as the original developer is no longer actively involved in the Nuxt universe.
Features
- Create PDF from Vue template
- Automatic PDF Generation
- Customizable Metadata
- Supports various paper sizes (A1, A2, A3, A4, A5, Letter, Legal, Tabloid)
- Support for dynamic routes (Nuxt Generate)
- Support for dynamic titles (from the
<title>tag) - I18n support for specific languages
- Generates PDFs as you edit (Automatic PDF regeneration)
- Compatible with Nuxt 2.x and higher
Installation
To install the Nuxt PDF theme, follow these steps:
- Add the
nuxt-pdfpackage to your project by running the following command:
npm install nuxt-pdf
- In your
nuxt.config.jsfile, addnuxt-pdfto thebuildModulessection:
buildModules: [
'nuxt-pdf'
]
- Customize the configuration by adding the
pdfproperty:
pdf: {
// your configuration options here
}
For a complete list of available configuration options, refer to the example configuration provided.
Summary
Nuxt PDF is a useful tool for generating PDF files from the content on your website. It offers features such as dynamic route support, customizable metadata, and automatic regeneration of PDFs as you edit. The theme is compatible with Nuxt 2.x and higher. Follow the installation guide to start using Nuxt PDF in your project.