3.8 KiB
#deck.js
A JavaScript library for building modern HTML presentations. deck.js is flexible enough to let advanced CSS and JavaScript authors craft highly customized decks, but also provides templates and themes for the HTML novice to build a standard slideshow.
Dependencies (included in this repository)
Documentation
Check out the documentation page for more information on the methods, events, and options available in core and all the included extensions. A sample standard slide deck is included in the package under the introduction
folder. You can also view that sample deck online to play with the available style and transition themes.
More Extensions and Related Projects
If you have an extension, theme, or project related to or using deck.js, please send me a link and I'll add it to this list.
- deck.js-codemirror by iros: Integrates codemirror into deck.js, giving you editable, executable, syntax highlighted code snippets right inside your slides.
- deck.remote.js by seppo0010: Uses node.js to give speakers a remote view to control slides, keep notes, and preview previous+next slides.
- deckjs-remote by chrisjaure: Control your deck remotely through a node.js service. Presenters can use the publicly available service or host it themselves.
- deckem by DamonOehlman: Jade templating for deck.js.
- markdown2deckjs by ulf: Write your slides in Markdown and convert them into a full working deck.
- deck.gotonumkey.js by KingHenne: A small extension that lets you jump to any slide by pressing the corresponding number key(s).
Tests & Support
Unit tests are written with Jasmine and jasmine-jquery. You can run them here.
deck.js has been tested with jQuery 1.6+ and works in IE7+, Chrome, FF, Safari, and Opera. The more capable browsers receive greater enhancements, but a basic cutaway slideshow will work for all browsers listed above. Please don't give your presentations in IE6.
Known Bug(s)
There is an issue with certain builds of Chrome that result in a solid blue background and generally broken decks. This is a bug in Chrome (Issue 91518) that stems from hardware acceleration of 3d transforms. Current workarounds:
- Use a different browser. This problem doesn't exist in Safari, FF, Opera.
- Disable hardware compositing by setting
--disable-accelerated-compositing
in the Chrome loading options - Replace instances of
translate3d
withtranslate
in the CSS of your decks (though this will slow down performance on iOS devices and Safari.)
Printing
Core includes stripped down black and white print styles for the standard slide template that is suitable for handouts.
Awesome People
Big thanks to the folks who have contributed code to the project:
- jbuck - Touch controls.
License
Copyright (c) 2011 Caleb Troughton
Dual licensed under the MIT license and GPL license.