bespoke-pdf-electron-helper
v1.0.1
Published
PDF plugin for Bespoke.js
Downloads
6
Maintainers
deckReadme
bespoke-pdf-electron-helper
PDF generatation helper for 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:
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:
bespoke.from('article', [
bespoke.plugins.pdf()
]);Install
$ npm install bespoke-pdf-electron-helperPDF 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 <html> element.
We can use this class to style any part of the page,
e.g. in Stylus:
.pdf
#my-fancy-overlay
display noneLikewise 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
.pdf
[data-bespoke-hash="named-route"]
display nonebespoke-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:
[data-pdf-id="emphatic-slide!"]
display noneSee 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
Sponsorship
Sponsored by nearForm