An open API service indexing awesome lists of open source software.

https://github.com/abians/pdf-make-previewer

CLI and library to visualize your PDF generation in real-time.
https://github.com/abians/pdf-make-previewer

pdf pdf-make-viewer pdf-viewer pdfmake pdfmake-library pdfmake-viewer pdfmake-viewer-js viewer

Last synced: 2 months ago
JSON representation

CLI and library to visualize your PDF generation in real-time.

Awesome Lists containing this project

README

        


PDF Make Previewer
npm travis licenses


CLI and library to visualize your PDF generation in real-time.

## ✨ Features

- πŸ“„ **Real-time PDF Preview:** Visualize PDF changes as you modify your generation logic without needing to regenerate files manually.
- πŸ›  **Easy CLI Setup:** Quickly configure and preview your PDFs using the CLI.
- βš™οΈ **Customizable Config:** Define your PDF generation logic in a dedicated config file.
- πŸ›  **Lightweight:** Simple and focused tool for PDF previewing during development.

## πŸ“š Documentation

For more information on how to use pdf-make-previewer, check out the [documentation](https://pdf-make-preview.vercel.app/).

## πŸš€ Quick Start

Run the following command to set up pdf-make-previewer in your project:

```bash
npx pdf-make-previewer init
```

This will guide you through the setup process and generate a configuration file for your project.

## πŸ“„ Configuration

In the configuration file, import your PDF generation logic. Here’s an example:

```ts
// pdf-preview.config.ts

import type { PdfPreviewerConfig } from "pdf-make-previewer"
import { generatePDF } from './your-pdf-functions';

const config: PdfPreviewerConfig = {
renderPdfPreview: () => generatePDF({name: 'John Doe', age: 30}),
}

export default config
```

## πŸš€ Run the Preview

To start using pdf-make-previewer, run:

```bash
npm run preview
```

This will open a local server where you can instantly preview any changes made to your PDF generation logic. Make your edits, save the file, and the preview will automatically update in real time. πŸ”„βœ¨

## 🀝 Contributions

Contributions are welcome. If you find an issue or have an idea to improve react-component-screenshot, feel free to open an issue or submit a pull request. πŸš€

## πŸ“œ License

Licensed as MIT open source. πŸ“œ