shivaprsd / doq

The missing reader mode/color schemes tool for PDFs. 👓
https://shivaprsd.github.io/doq/
MIT License
33 stars 0 forks source link

Node.js integration and NPM package #6

Open shivaprsd opened 2 years ago

shivaprsd commented 2 years ago

An NPM package would be useful to devs wishing to integrate doq in their projects.

I am not familiar with the Node.js platform, so help in this direction is most welcome.

wyatt commented 1 year ago

Happy to help with this!

I'd recommend using https://github.com/marketplace/actions/npm-publish, which will trigger an NPM deploy every time there's a version change.

You'll need to add the action, and set an action env variable which will be your NPM token (https://docs.npmjs.com/creating-and-viewing-access-tokens)

shivaprsd commented 1 year ago

Thanks for stopping by! I followed the pointers you gave. Really useful. 👍🏼

But before publishing, we need to figure out how exactly the PDF.js generic viewer is integrated by projects in NodeJS. Only then we can make necessary code changes and provide instructions to integrate doq into their setup.

I think there are some Node-integration examples in the PDF.js repo. Any pointers in that directions are appreciated. 🙂

shivaprsd commented 1 year ago

I went through the PDF.js and Node.js docs. Added to Todo.