docs: hopefully-temporary note about .pdf() needingheadless mode

schickling · Aug 2, 2017 · 9b21578 · 9b21578
1 parent df46e72
commit 9b21578
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -414,6 +414,9 @@ Print to a PDF of the document as framed by the viewport.
 When running Chromeless locally this returns the local file path to the PDF.
 When run over the Chromeless Proxy service, a URL to the PDF on S3 is returned.
 
+Requires that Chrome be running headless-ly. [More](https://github.com/graphcool/chromeless/issues/146)
+
+
 __Arguments__
 - `options` - An object containing overrides for [printToPDF() parameters](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF)