Skip to content

Commit a406056

Browse files
committed
Update language from html2pdf to html2pdf.js
1 parent d18de9d commit a406056

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# html2pdf
1+
# html2pdf.js
22

3-
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).
3+
html2pdf.js 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

55
## Table of contents
66

@@ -32,7 +32,7 @@ html2pdf converts any webpage or element into a printable PDF entirely client-si
3232

3333
#### HTML
3434

35-
The simplest way to use html2pdf is to download `dist/html2pdf.bundle.min.js` to your project folder and include it in your HTML with:
35+
The simplest way to use html2pdf.js is to download `dist/html2pdf.bundle.min.js` to your project folder and include it in your HTML with:
3636

3737
```html
3838
<script src="html2pdf.bundle.min.js"></script>
@@ -42,17 +42,17 @@ The simplest way to use html2pdf is to download `dist/html2pdf.bundle.min.js` to
4242

4343
#### NPM
4444

45-
Install html2pdf and its dependencies using NPM with `npm install --save html2pdf.js` (make sure to include `.js` in the package name).
45+
Install html2pdf.js and its dependencies using NPM with `npm install --save html2pdf.js` (make sure to include `.js` in the package name).
4646

47-
*Note: You can use NPM to create your project, but html2pdf **will not run in Node.js**, it must be run in a browser.*
47+
*Note: You can use NPM to create your project, but html2pdf.js **will not run in Node.js**, it must be run in a browser.*
4848

4949
#### Bower
5050

51-
Install html2pdf and its dependencies using Bower with `bower install --save html2pdf.js` (make sure to include `.js` in the package name).
51+
Install html2pdf.js and its dependencies using Bower with `bower install --save html2pdf.js` (make sure to include `.js` in the package name).
5252

5353
#### Console
5454

55-
If you're on a webpage that you can't modify directly and wish to use html2pdf to capture a screenshot, you can follow these steps:
55+
If you're on a webpage that you can't modify directly and wish to use html2pdf.js to capture a screenshot, you can follow these steps:
5656

5757
1. Open your browser's console (instructions for different browsers [here](https://webmasters.stackexchange.com/a/77337/94367)).
5858
2. Paste in this code:
@@ -65,11 +65,11 @@ If you're on a webpage that you can't modify directly and wish to use html2pdf t
6565
}
6666
addScript('https://raw.githack.com/eKoopmans/html2pdf/master/dist/html2pdf.bundle.js');
6767
```
68-
3. You may now execute html2pdf commands directly from the console. To capture a default PDF of the entire page, use `html2pdf(document.body)`.
68+
3. You may now execute html2pdf.js commands directly from the console. To capture a default PDF of the entire page, use `html2pdf(document.body)`.
6969

7070
## Usage
7171

72-
Once installed, html2pdf is ready to use. The following command will generate a PDF of `#element-to-print` and prompt the user to save the result:
72+
Once installed, html2pdf.js is ready to use. The following command will generate a PDF of `#element-to-print` and prompt the user to save the result:
7373

7474
```js
7575
var element = document.getElementById('element-to-print');
@@ -78,7 +78,7 @@ html2pdf(element);
7878

7979
### Advanced usage
8080

81-
Every step of html2pdf is configurable, using its new Promise-based API. If html2pdf is called without arguments, it will return a `Worker` object:
81+
Every step of html2pdf.js is configurable, using its new Promise-based API. If html2pdf.js is called without arguments, it will return a `Worker` object:
8282

8383
```js
8484
var worker = html2pdf(); // Or: var worker = new html2pdf.Worker;
@@ -93,7 +93,7 @@ var worker = html2pdf().from(element).save();
9393

9494
#### Workflow
9595

96-
The basic workflow of html2pdf tasks (enforced by the prereq system) is:
96+
The basic workflow of html2pdf.js tasks (enforced by the prereq system) is:
9797

9898
```
9999
.from() -> .toContainer() -> .toCanvas() -> .toImg() -> .toPdf() -> .save()
@@ -128,7 +128,7 @@ A few aliases are also provided for convenience:
128128
129129
## Options
130130
131-
html2pdf can be configured using an optional `opt` parameter:
131+
html2pdf.js can be configured using an optional `opt` parameter:
132132
133133
```js
134134
var element = document.getElementById('element-to-print');
@@ -161,9 +161,9 @@ The `opt` parameter has the following optional fields:
161161

162162
### Page-breaks
163163

164-
html2pdf has the ability to automatically add page-breaks to clean up your document. Page-breaks can be added by CSS styles, set on individual elements using selectors, or avoided from breaking inside all elements (`avoid-all` mode).
164+
html2pdf.js has the ability to automatically add page-breaks to clean up your document. Page-breaks can be added by CSS styles, set on individual elements using selectors, or avoided from breaking inside all elements (`avoid-all` mode).
165165

166-
By default, html2pdf will respect most CSS [`break-before`](https://developer.mozilla.org/en-US/docs/Web/CSS/break-before), [`break-after`](https://developer.mozilla.org/en-US/docs/Web/CSS/break-after), and [`break-inside`](https://developer.mozilla.org/en-US/docs/Web/CSS/break-inside) rules, and also add page-breaks after any element with class `html2pdf__page-break` (for legacy purposes).
166+
By default, html2pdf.js will respect most CSS [`break-before`](https://developer.mozilla.org/en-US/docs/Web/CSS/break-before), [`break-after`](https://developer.mozilla.org/en-US/docs/Web/CSS/break-after), and [`break-inside`](https://developer.mozilla.org/en-US/docs/Web/CSS/break-inside) rules, and also add page-breaks after any element with class `html2pdf__page-break` (for legacy purposes).
167167

168168
#### Page-break settings
169169

@@ -218,7 +218,7 @@ The Worker object returned by `html2pdf()` has a built-in progress-tracking mech
218218

219219
## Dependencies
220220

221-
html2pdf depends on the external packages [html2canvas](https://github.com/niklasvh/html2canvas), [jsPDF](https://github.com/MrRio/jsPDF), and [es6-promise](https://github.com/stefanpenner/es6-promise). These dependencies are automatically loaded when using NPM or the bundled package.
221+
html2pdf.js depends on the external packages [html2canvas](https://github.com/niklasvh/html2canvas), [jsPDF](https://github.com/MrRio/jsPDF), and [es6-promise](https://github.com/stefanpenner/es6-promise). These dependencies are automatically loaded when using NPM or the bundled package.
222222

223223
If using the unbundled `dist/html2pdf.min.js` (or its un-minified version), you must also include each dependency. Order is important, otherwise html2canvas will be overridden by jsPDF's own internal implementation:
224224

@@ -233,11 +233,11 @@ If using the unbundled `dist/html2pdf.min.js` (or its un-minified version), you
233233

234234
### Issues
235235

236-
When submitting an issue, please provide reproducible code that highlights the issue, preferably by creating a fork of [this template jsFiddle](https://jsfiddle.net/u6o6ne41/) (which has html2pdf already loaded). Remember that html2pdf uses [html2canvas](https://github.com/niklasvh/html2canvas) and [jsPDF](https://github.com/MrRio/jsPDF) as dependencies, so it's a good idea to check each of those repositories' issue trackers to see if your problem has already been addressed.
236+
When submitting an issue, please provide reproducible code that highlights the issue, preferably by creating a fork of [this template jsFiddle](https://jsfiddle.net/u6o6ne41/) (which has html2pdf.js already loaded). Remember that html2pdf.js uses [html2canvas](https://github.com/niklasvh/html2canvas) and [jsPDF](https://github.com/MrRio/jsPDF) as dependencies, so it's a good idea to check each of those repositories' issue trackers to see if your problem has already been addressed.
237237

238238
### Tests
239239

240-
html2pdf is currently sorely lacking in unit tests. Any contributions or suggestions of automated (or manual) tests are welcome. This is high on the to-do list for this project.
240+
html2pdf.js is currently sorely lacking in unit tests. Any contributions or suggestions of automated (or manual) tests are welcome. This is high on the to-do list for this project.
241241

242242
### Pull requests
243243

0 commit comments

Comments
 (0)