Plugin for bespoke.js that allows fast searching through a slide deck
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
dist
spec
src
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
CONTRIBUTING.md
Gruntfile.js
LICENSE
README.md
bower.json
package.json

README.md

Build Status

bespoke-spotlight

Fast Search for Bespoke.js slide-decks.

Download

Download the production version or the development version, and the css, or use a package manager.

Usage

First, include both bespoke.js, bespoke-spotlight.js and bespoke-spotlight.css in your page.

Then, simply include the plugin when instantiating your presentation.

bespoke.horizontal.from('article', {
  spotlight: true
});

Press 'q' (for query) on your keyboard to bring up the search field and 'RETURN' or 'ESC' to close it.

As you type spotlight automatically navigates to the first slide that contains matching text. Spotlight will search headings first, then all other content

Questions?

Contact me on GitHub or Twitter: @mobz

Package managers

Bower

$ bower install bespoke-spotlight

npm

$ npm install bespoke-spotlight

The bespoke-spotlight npm package is designed for use with browserify, e.g.

require('bespoke');
require('bespoke-spotlight');

Credits

This plugin was built with generator-bespokeplugin.

License

Copyright 2013, Ben Birch
This content is released under the MIT license
http://mit-license.org/mobz