https://github.com/statamic/pdfcrowd
https://github.com/statamic/pdfcrowd
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/statamic/pdfcrowd
- Owner: statamic
- Created: 2016-06-06T20:05:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-06T20:29:40.000Z (about 9 years ago)
- Last Synced: 2025-03-22T04:41:27.287Z (3 months ago)
- Language: PHP
- Size: 8.79 KB
- Stars: 6
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PDFcrowd 
> Generate and download PDFs based on HTML and CSS using [PDFcrowd][pdfcrowd].
## Setup
- Sign up for [PDFcrowd][pdfcrowd].
- Install the addon by copying the contents of this repo to `site/addons/Pdfcrowd`.
- Create a `site/settings/addons/pdfcrowd.yaml` file and add your username and API key:
```
username: username_here
api_key: api_key_here
```
## Usage
Design your PDF using HTML and CSS then use the `pdfcrowd:generate` tag to generate the PDF.
### Generate tag
Generate and download a PDF from a URL. You can use a `url` parameter of a single tag or place the URL between a tag pair.
```
{{ pdfcrowd:generate url="/url/of/page/to/pdf" }}
```
```
{{ pdfcrowd:generate }}
/url/of/page/to/pdf
{{ /pdfcrowd:generate }}
```
_Notes:_
This tag will trigger a download of the PDF. The actual template will not be rendered. For example, you'll
probably want to do something like `Download PDF`.
The URL must be publicly accessible so that PDFcrowd can view it.
## Configuration
You may configure the settings for your PDFs by adding items to your `site/addons/pdfcrowd.yaml` file.
All the settings are available inside `default.yaml`. Simply copy the settings you wish to adjust
into your `pdfcrowd.yaml` file, and modify them.
[pdfcrowd]: http://pdfcrowd.com/