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.
- Host: GitHub
- URL: https://github.com/abians/pdf-make-previewer
- Owner: AbianS
- Created: 2024-10-05T12:02:00.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T03:39:29.000Z (4 months ago)
- Last Synced: 2025-03-30T11:02:23.540Z (3 months ago)
- Topics: pdf, pdf-make-viewer, pdf-viewer, pdfmake, pdfmake-library, pdfmake-viewer, pdfmake-viewer-js, viewer
- Language: TypeScript
- Homepage: https://pdf-make-preview.vercel.app
- Size: 515 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
PDF Make Previewer
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. 📜