Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

Latest commit

 

History

History
86 lines (50 loc) · 3.77 KB

README.md

File metadata and controls

86 lines (50 loc) · 3.77 KB
Raw

(I'm switching to https://sli.dev/ and not actively maintaining this deck.js fork)

This repository is a merge of:

  • the main deck.js project
  • the deck.events.js extension project (+ my patch)
  • all my extensions (SVG, anim, clone/presenter view, ...)

If you want to start using deck.js with these extensions, have a look at the starter kit at https://github.com/twitwi/deck.js-starterkit/.

NB: the README below is the one from deck.js, as is.

#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.

Quick Start

This repository includes a boilerplate.html as a starting point, with all the extensions included. Just download it, open boilerplate.html, and start editing your slides.

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.

Extensions, Themes, and Related Projects

Take a look at the wiki for lists of extensions, themes, and other related goodies. If you have a publicly available project of your own, feel free to add to the list.

Dependencies (included in this repository)

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.

For any questions or general discussion about deck.js please direct your attention to the mailing list (uses Google groups.) If you would like to report a bug, please see the issues page.

Printing

Core includes stripped down black and white print styles for the standard slide template that is suitable for handouts.

Awesome Contributors

If you would like to contribute a patch to deck.js please do as much as you can of the following:

  • Add or amend Jasmine tests.
  • Add inline documentation.
  • If the standard snippet of an extension changes, please change it in both the introduction deck and the snippet html in the extension folder.
  • If the API changes, it would be awesome to receive a parallel pull request to the gh-pages branch which updates the public-facing documentation.

License

Copyright (c) 2011-2014 Caleb Troughton

Licensed under the MIT license