bespoke-notes's Introduction

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

bespoke-notes's People

Contributors

Stargazers

Watchers

bespoke-notes's Issues

Cannot find module './style'

I'm working on a newly generated bespoke presentation and wanted to use the notes plugin. When I run gulp serve I get the following error:

Error: module "./style" not found from "/Users/tennety/Documents/presos/stirtrek-2016/node_modules/bespoke-notes/index.js"
    at notFound (/Users/tennety/Documents/presos/stirtrek-2016/node_modules/gulp-browserify/node_modules/browserify/index.js:803:15)
    at /Users/tennety/Documents/presos/stirtrek-2016/node_modules/gulp-browserify/node_modules/browserify/index.js:754:23
    at /Users/tennety/Documents/presos/stirtrek-2016/node_modules/gulp-browserify/node_modules/browserify/node_modules/browser-resolve/index.js:185:24

Am I missing something?

Recommend Projects