Skip to content

Commit f885cbc

Browse files
added action informations in README
1 parent a3291b1 commit f885cbc

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
11
# html-to-pdf-action
22

3-
This action will automatically render a webpage into a PDF.
3+
This action will automatically render any local webpage into a PDF.
44

5-
Because it integrates a web-server, it will have no problems importing css, js and fonts (local or external), and will wait for everything to render properly before rending the output to a PDF. It means your webpage doesn't have to be a static HTML page, but can also use javascript frameworks.
5+
Because it integrates its own web-server, it has no problems importing css, js and fonts (whether available locally or referenced online, including from websites like google fonts), and will wait for everything to render properly before rending the output to a PDF. It means your webpage doesn't have to be a static HTML page, but can also use any javascript framework.
66

7-
The action internally uses chromium, so the rendered PDF won't have the weird problems you can have with Firefox or WebKit.
7+
The action internally uses chromium, so the rendered PDF won't have any of the weird problems that exist with Firefox or WebKit, like:
8+
- font kerning
9+
- missing styles or resources
10+
- javascript not executed before rendering
11+
- ...
812

9-
Here is an example use of the action:
13+
Here is an example on how to use the action:
1014

1115
```yml
1216
- name: HTML website to PDF converter
13-
uses: ferdinandkeller/html-to-pdf-action@v1.3.0
17+
uses: ferdinandkeller/html-to-pdf-action@v1
1418
with:
1519
- source-path: './dist'
16-
- destination-path: './pdf/resume.pdf'
17-
```
20+
- destination-path: './out.pdf'
21+
```
22+
23+
The `source-path` parameter specify which directory contains your builded html (your main file must be called `index.html`), while `destination-path` is the path where you want to put your PDF.
24+
25+
Even though puppeteer (which this generator uses) only supports `AMD64`, thanks to some tweeking this Dockerfile and this GitHub action can work on pretty much any architecture supported by chromium, including on `AMD64` and `ARM64`.

0 commit comments

Comments
 (0)