Skip to content

medikoo/bespoke-notes

Repository files navigation

bespoke-notes

Notes for Bespoke.js presentations

Use cases:

  • Publish slides with notes to those who were not able to see the presentation
  • Write notes for presentation, and present it on two screens (with help of bespoke-sync):
    Audience screen:                      Your screen:

See Asynchronous JavaScript Interfaces presentation for demo

Usage

bespoke-notes uses <aside> elements as notes.

...
<section>
  <h2>My Slide</h2>
  <aside>
    <p>My Notes</p>
  </aside>
</section>
...
// If your CJS bundler supports CSS modules do:
notes = require('bespoke-notes');
// otherwise do following (and aside ensure that rules from style.css are loaded in your browser)
notes = require('bespoke-notes/dom');

bespoke.from(selector, [
  notes()
]);

Possible options:

bespoke.from(selector, [
  notes({
    key: 0x4e, // (optional) Key that toggles notes, defaults to 'n'
    visible: false, // (optional) Whether to display notes on startup
  })
]);

Additionally notes display can be forced via ?notes query in url search string

Installation

npm

In your presentation path:

$ npm install bespoke-notes

About

Display slide notes in Bespoke.js presentations

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published