Skip to content

Commit b6abbf6

Browse files
committed
Merge branch 'release/v0.9.1' into develop
2 parents d05cf71 + 3771146 commit b6abbf6

File tree

10 files changed

+6206
-1750
lines changed

10 files changed

+6206
-1750
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
html2pdf converts any webpage or element into a printable PDF entirely client-side using [html2canvas](https://github.com/niklasvh/html2canvas) and [jsPDF](https://github.com/MrRio/jsPDF).
44

5+
## Table of contents
6+
7+
- [Getting started](#getting-started)
8+
- [HTML](#html)
9+
- [NPM](#npm)
10+
- [Bower](#bower)
11+
- [Usage](#usage)
12+
- [Advanced usage](#advanced-usage)
13+
- [Workflow](#workflow)
14+
- [Worker API](#worker-api)
15+
- [Options](#options)
16+
- [Page-breaks](#page-breaks)
17+
- [Page-break settings](#page-break-settings)
18+
- [Page-break modes](#page-break-modes)
19+
- [Example usage](#example-usage)
20+
- [Image type and quality](#image-type-and-quality)
21+
- [Progress tracking](#progress-tracking)
22+
- [Dependencies](#dependencies)
23+
- [Contributing](#contributing)
24+
- [Issues](#issues)
25+
- [Tests](#tests)
26+
- [Pull requests](#pull-requests)
27+
- [Credits](#credits)
28+
- [License](#license)
29+
530
## Getting started
631

732
#### HTML
@@ -169,7 +194,7 @@ You may customize the image type and quality exported from the canvas by setting
169194

170195
These options are limited to the available settings for [HTMLCanvasElement.toDataURL()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toDataURL), which ignores quality settings for 'png' images. To enable png image compression, try using the [canvas-png-compression shim](https://github.com/ShyykoSerhiy/canvas-png-compression), which should be an in-place solution to enable png compression via the `quality` option.
171196

172-
## Progress
197+
## Progress tracking
173198

174199
The Worker object returned by `html2pdf()` has a built-in progress-tracking mechanism. It will be updated to allow a progress callback that will be called with each update, however it is currently a work-in-progress.
175200

0 commit comments

Comments
 (0)