diff --git a/README.md b/README.md index 85bbbc9..67712e8 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,7 @@ The `cs` instance of a [`PDPageContentStream`](https://pdfbox.apache.org/docs/2.0.5/javadocs/org/apache/pdfbox/pdmodel/PDPageContentStream.html) object contains a bunch of methods that can be used to render onto the current page. -`:objects` +#### `:objects` You can include `` elements in your HTML and implement completely custom rendering for them using a `Graphics2D` object by providing custom functions under the `:objects` key in your options. @@ -197,6 +197,76 @@ a bit of CSS to give them some size so that they will be rendered. For example: ``` +#### `:debug` + +Two options are currently available under here that can be useful to troubleshoot issues if your PDF is not rendering +as you would expect. + +Setting `:display-html?` to true will cause `->pdf` to display the final HTML string (via stdout) that is being +rendered (the final HTML _after_ all of the fancy options `