Studiosity / grover

A Ruby gem to transform HTML into PDFs, PNGs or JPEGs using Google Puppeteer/Chromium

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update refs to puppeteer docs

ahkay opened this issue · comments

commented

Love your work, thanks. We are migrating to Grover after years of struggles with Wicked PDF because we are rendering d3.js graphs as well as sending PDFs on a schedule. The silent failures of Wicked PDF with limited debug options & ES6 incompatibility have become too much.

I noticed the docs reference outdated Puppeteer docs. (for example, https://github.com/Studiosity/grover#configuration refers to https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions which results in the 404 jedi mind trick, and it probably should be https://devdocs.io/puppeteer/index#pagepdfoptions)

Shall I submit a PR with suggested changes to readme?

Nice catch, thanks @ahkay 👍 Certainly not the first time the Puppeteer docs have been refactored!

I suspect in your example the direct equivalent would be https://github.com/puppeteer/puppeteer/blob/main/docs/api/puppeteer.pdfoptions.md
but following the API doc path the Puppeteer project references it would be https://pptr.dev/api/puppeteer.pdfoptions

I think either of those would work, but I'm not too bothered either way! A PR to fix them would be fantastic, thanks 😄