# bespoke-pdf-electron-helper > PDF plugin for Bespoke.js Latest version **1.0.1** (published 2015-10-22) · 0 weekly downloads ## Install ```sh npm install bespoke-pdf-electron-helper pnpm add bespoke-pdf-electron-helper yarn add bespoke-pdf-electron-helper bun add bespoke-pdf-electron-helper ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2015-10-22 | | First published | 2015-10-22 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10.0 | | Dependencies | 0 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | David Clements | | Maintainers | deck | | Keywords | bespoke-plugin, bespoke, PDF, slides, presentation, markdown | ## Links - npm: https://www.npmjs.com/package/bespoke-pdf-electron-helper - Repository: https://github.com/davidmarkclements/bespoke-pdf-electron-helper - Homepage: https://github.com/davidmarkclements/bespoke-pdf-electron-helper#readme - Issues: https://github.com/davidmarkclements/bespoke-pdf-electron-helper/issues - npm.io page: https://npm.io/package/bespoke-pdf-electron-helper ## Alternatives - [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads - [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads - [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads - [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads - [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads ## Recent versions - 1.0.1 (latest) — 2015-10-22 - 1.0.0 — 2015-10-22 ## README # bespoke-pdf-electron-helper PDF generatation helper for [Bespoke.js](https://github.com/markdalgleish/bespoke.js) ## Bespoke Plugin ### Download ### Usage `bespoke-pdf-electron-helper` is a bespoke-plugin that exposes a global BESPOKE_PDF global within an electron render process. This can be used to control the slides and supply PDF specific formatting so that electron can take snapshots and populate a PDF file. For example, when using CommonJS modules: ```js var bespoke = require('bespoke'), pdf = require('bespoke-pdf-electron-helper'); bespoke.from('article', [ pdf() ]); } ``` #### Options ##### setup [Function] ``` bespoke.from('article', [ pdf({ setup: function () { //prime slide environment for pdf output //for instance, disable the "camera" slide or whatever } }) ]); ``` ##### delay [Number] Delay before slide taking begins ##### evalDelay [Number] Delay between each shot When using browser globals: ```js bespoke.from('article', [ bespoke.plugins.pdf() ]); ``` ### Install ```bash $ npm install bespoke-pdf-electron-helper ``` ### PDF Output Customizations In some cases, we don't want certain presentation visuals landing in generated PDF's. During PDF generation, `bespoke-pdf` adds a `pdf` class to the root `` element. We can use this class to style any part of the page, e.g. in Stylus: ```styl .pdf #my-fancy-overlay display none ``` Likewise there may be particular slides. Any hidden `section` element will be removed from the deck prior to PDF generation. For instance, say we're using `bespoke-hash` and we have a slide called `named-route`, we could do ```styl .pdf [data-bespoke-hash="named-route"] display none ``` `bespoke-pdf` will detect this and remove the slide. To enable the use markdown without littering it with structural HTML tags, `bespoke-pdf` also provides another way to style and hide slides by adding a `data-pdf-id` attribute based on the slides headline, which is determined by the first `h1`, `h2`, `h3`, `h4`, `h5`, `li`, `p` or `span` element in that order. For instance, say there's a slide with an `h2` element named "Emphatic Slide!". `bespoke-pdf` automatically creates a `data-pdf-id` attribute with the value of `emphatic-slide!` (we lowercase and replace spaces with dashes). This allows us to remove it like so: ```styl [data-pdf-id="emphatic-slide!"] display none ``` See the `example/src/styles/main.styl` file for an example of this - and notice that `example/dist/presentation-hello-world.pdf` lacks the "Emphatic Slide!" slide. ## License [MIT License](http://en.wikipedia.org/wiki/MIT_License) ## Sponsorship Sponsored by [nearForm](http://nearform.com) --- _Source: https://npm.io/package/bespoke-pdf-electron-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._