Skip to content

Add documentation for simple PDF usage #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f3l1x merged 1 commit into from
Dec 14, 2025
Merged

Add documentation for simple PDF usage #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Force file to display in a browser](#force-file-to-display-in-a-browser)
- [Set a pdf background easily](#set-a-pdf-background-easily)
- [Create pdf with latte only](#create-pdf-with-latte-only)
- [Configuration of custom fonts for mPDF](#configuration-of-custom-fonts-for-mpdf)
- [Configuration of custom temp dir for mPDF in PdfResponse](#configuration-of-custom-temp-dir-for-mpdf-in-pdfresponse)

## Usage
Expand Down Expand Up @@ -155,6 +156,32 @@ public function actionPdf()
}
```

### Configuration of custom fonts for mPDF

```php
use Contributte\PdfResponse\PdfResponse;

public function actionPdf()
{
$template = $this->createTemplate();
$template->setFile(__DIR__ . "/path/to/template.latte");

$pdf = new PdfResponse($template);
$pdf->mpdfConfig = [
'fontDir' => [__DIR__ . '/fonts'],
'fontdata' => [
'poppins' => [
'R' => 'Poppins-Regular.ttf',
'B' => 'Poppins-Bold.ttf',
],
],
'default_font' => 'poppins',
];

$this->sendResponse($pdf);
}
```

### Configuration of custom temp dir for mPDF in PdfResponse

```neon
Expand Down
Loading