Skip to content

Latest commit

 

History

History
76 lines (39 loc) · 2.4 KB

README.md

File metadata and controls

76 lines (39 loc) · 2.4 KB

Print.js

Build Status Software License Standard - JavaScript Style Guide npm

A tiny javascript library to help printing from the web.

For documentation and examples please visit: printjs.crabbly.com

Installation

You can download the latest version of Print.js on GitHub or just use the Print.js CDN links available on the documentation page.

To install via npm:

npm install print-js --save

To install via yarn:

yarn add print-js

Documentation

You can find documentation at printjs.crabbly.com.

Contributing to Print.js

Contributions to Print.js are welcome and encouraged.

Using issues

The issue tracker is the preferred channel for reporting bugs, requesting new features and submitting pull requests.

Keep in mind that we would like to keep this a lightweight library.

Please do not use the issues channel for support requests. For help using Print.js, please ask questions on Stack Overflow and use the tag printjs.

Reporting bugs

Well structured, detailed bug reports are hugely valuable for the project.

  • Check the issue search to see if it has already been reported
  • Isolate the problem to a simple test case

Please provide any additional details associated with the bug.

Pull requests

Clear, concise pull requests are excellent at continuing the project's community driven growth.

Please make your commits in logical sections with clear commit messages.

Setting up dev environment

npm install

npm run watch

If you want to do a quick test with your modified code: python -m SimpleHTTPServer 9001 Navigate to http://localhost:9001/test.html

When you are ready to put in your PR and want to update the dist/ with a minified production-ready version, do npm run production

License

Print.js is available under the MIT license.