Skip to content

Commit 02748ee

Browse files
committed
Add footer and header support to readme
1 parent 3ae925d commit 02748ee

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,24 @@ pdf.create(html).toBuffer(function(err, buffer){
5555
pdf.create(html [, options], function(err, buffer){});
5656
```
5757

58+
### Footers and Headers
59+
60+
`html-pdf` can read the header or footer of a page out of the html source. You can either set a default header or footer or overwrite that by appending a page number (1 based index) to the `id="pageHeader"` attribute of a html tag.
61+
62+
You can use any combination of those tags. The library tries to find any element, that contains the `pageHeader` or `pageFooter` id prefix.
63+
```html
64+
<div id="pageHeader">Default header</div>
65+
<div id="pageHeader-first">Header on first page</div>
66+
<div id="pageHeader-2">Header on second page</div>
67+
<div id="pageHeader-3">Header on third page</div>
68+
<div id="pageHeader-last">Header on last page</div>
69+
...
70+
<div id="pageFooter">Default footer</div>
71+
<div id="pageFooter-first">Footer on first page</div>
72+
<div id="pageFooter-2">Footer on second page</div>
73+
<div id="pageFooter-last">Footer on last page</div>
74+
```
75+
5876

5977
## Options
6078
```javascript

0 commit comments

Comments
 (0)