Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.54 KB

Contributing

All contributions to this repository are welcome!

I appreciate feedback of any kind via GitHub issues:

  • bug reports
  • feature suggestions
  • examples of web pages where percollate could do a better job

You can contribute to the code base via Pull Requests. For small, straightforward fixes, you can create a PR directly. For more sophisticated changes, let's discuss it first in an issue to make sure we're on the same page.

Setting up the project locally

Clone the repository to your local computer:

git clone [email protected]:danburzo/percollate.git
cd percollate

Then install the necessary dependencies

# using npm
npm install

# using yarn
yarn

You can then run the CLI by using ./cli.js instead of percollate:

./cli.js pdf --output some.pdf http://example.com

💡 You may need to add execution permissions to the file using chmod +x ./cli.js

Debugging the temporary HTML

If the generated PDF doesn't look like you'd expect, you can open the temporary HTML file that percollate generates in your browser to inspect the markup and styles.

./cli.js pdf http://www.huevaluechroma.com/072.php
Fetching: http://www.huevaluechroma.com/072.php
Enhancing web page
Generating temporary HTML file at:
> file:///var/folders/yy/h2wycn3j23n6lpf60qf3xmj40000gn/T/tmp-4720cQkEtujUSi0V.html
Saving PDF: The-Dimensions-of-Colour-traditional-colour-wheel.pdf