-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add screenshots and update README with detailed usage instructions 📸
- Loading branch information
1 parent
4b8bc80
commit a6acfdc
Showing
5 changed files
with
45 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# PDF Builder Operation for Directus | ||
|
||
The “PDF Builder Operation” extension for Directus allows automated generation of PDF files using custom JSON templates. | ||
This operation can be integrated within Directus workflows, allowing the creation of highly customized PDF documents. | ||
Use dynamic values extracted from other operations via `operationKey`, such as `{{read_users_collection.first_name}}`, | ||
to customize the PDF content. | ||
|
||
# Installation | ||
|
||
Refer to the [Official Guide](https://docs.directus.io/extensions/installing-extensions.html) for details on installing | ||
the extension from the Marketplace or manually. | ||
|
||
# Features | ||
|
||
- 📄 Generate PDF files based on JSON content | ||
- 🔗 Add external fonts via URL | ||
- 🔗 Add internal fonts via UUID | ||
- 📁 Custom file name and path | ||
- 🗂️ Store generated PDF files in Directus | ||
|
||
# Usage | ||
|
||
Add the `PDF Builder Operation` via the flow builder and configure the operation with the desired settings. The | ||
operation will generate a PDF file based on the provided JSON content. | ||
|
||
### General Form View | ||
|
||
This view shows the general configuration form for the PDF Builder operation, where you can define the operation key, | ||
permissions, filename, storage, and the JSON template that will be used to generate the PDF. | ||
|
||
![Operation General Form View](screenshots/operation_general_form_view.png) | ||
|
||
### Font URL Configuration | ||
|
||
In this view, you can configure an external font by providing the URL. Ensure that the URL points to a TTF font file, as | ||
only TTF fonts are supported. | ||
|
||
![Operation Font URL Form](screenshots/operation_font_url_form.png) | ||
|
||
### Font UUID Configuration | ||
|
||
This view allows you to select an internal font stored in Directus by using its UUID. The font must be of TTF type, and | ||
the UUID is obtained from the file's URL within Directus. | ||
|
||
![Operation Font UUID Form](screenshots/operation_font_uuid_form.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.