It's a presentation framework based on the power of CSS3 transforms and transitions in modern browsers and inspired by the idea behind prezi.com.
JavaScript CSS HTML
Pull request Compare This branch is 92 commits ahead, 11 commits behind impress:master.
Latest commit d2804fa Feb 12, 2017 @henrikingo Fix css for the demo so it works also with tinymce editor in impressi…
…onist project.

The two necessary fixes are:
 - slightly decrease font size for the #title "impress.js *" text
 - the word "big" becomes strong rather than b, css now supports either
Permalink
Failed to load latest commit information.
css Fix css for the demo so it works also with tinymce editor in impressi… Feb 12, 2017
examples Finish support for impress().tear(): Hook up all the plugins to the l… Dec 4, 2016
extras Add back impress-console as regular copy of files. Jul 13, 2016
js Fix: optional duration parameter to goto() function was ignored. Feb 12, 2017
src Fix: optional duration parameter to goto() function was ignored. Feb 12, 2017
test Only execute preStepLeave plugins from goto, when the new step is dif… Aug 17, 2016
.gitignore Merge upstream 0.6.0 release Jul 16, 2016
.gitmodules Remove impress-console submodule Jul 13, 2016
.jshintrc Run tests with Karma test runner Jun 16, 2016
.npmignore Add .npmignore Jul 3, 2016
CHANGELOG.md Fix notes from @bartaz Feb 2, 2016
DOCUMENTATION.md Add support for data-rotate-order="xyz" attribute. Oct 16, 2016
LICENSE Fix notes from @bartaz Feb 2, 2016
README.md Modify QUnit tests to use iframe and work with karma. Jul 17, 2016
apple-touch-icon.png even more iPad love Feb 15, 2012
bower.json Merge upstream 0.6.0 release Jul 16, 2016
build.js Fix two JavaScript syntax issues to support an older Chrome version (… Dec 28, 2016
circle.yml Merge upstream 0.6.0 release Jul 16, 2016
favicon.png impressive favicon added Mar 10, 2012
index.html Fix the z-axis for 2 steps in the official demo. (Needs explicit 0.) Sep 10, 2016
karma.conf.js Disable Chrome in karma.conf.js as a temporary measure Jul 30, 2016
package.json Modify QUnit tests to use iframe and work with karma. Jul 17, 2016
qunit_test_runner.html Modify QUnit tests to use iframe and work with karma. Jul 17, 2016

README.md

impress.js

CircleCI

It's a presentation framework based on the power of CSS3 transforms and transitions in modern browsers and inspired by the idea behind prezi.com.

WARNING

impress.js may not help you if you have nothing interesting to say ;)

HOW TO USE IT

Reference documentation of all impress.js features and API you can find it in DOCUMENTATION.md.

The HTML source code of the official impress.js demo serves as a good example usage and contains comments explaning various features of impress.js. For more information about styling you can look into CSS code which shows how classes provided by impress.js can be used. Last but not least JavaScript code of impress.js has some useful comments if you are interested in how everything works. Feel free to explore!

Official demo

impress.js demo by @bartaz

Examples and demos

The Classic Slides demo is targeted towards beginners, or can be used as a template for presentations that look like the traditional PowerPoint slide deck.

More examples and demos can be found on Examples and demos wiki page.

Feel free to add your own example presentations (or websites) there.

Other tutorials and learning resources

If you want to learn even more there is a list of tutorials and other learning resources on the wiki, too.

There is also a book available about Building impressive presentations with impress.js by Rakhitha Nimesh Ratnayake.

REPOSITORY STRUCTURE

  • index.html: This is the official impress.js demo, showcasing all of the features of the original impress.js, as well as some new plugins as we add them.
    • As already mentioned, this file is well commented and acts as the canonical documentation.
  • examples/: Contains another demo that you can use as template for your first simple slide shows.
  • src/: The main file is src/impress.js. Additional functionality is implemented as plugins in src/plugins/.
  • test/: Contains QUnit and Syn libraries that we use for writing tests, as well as some test coverage for core functionality. (Yes, more tests are much welcome.) Tests for plugins are in the directory of each plugin.
  • js/: Contains js/impress.js, which contains a concatenation of the core src/impress.js and all the plugins. Traditionally this is the file that you'll link to in a browser. In fact both the demo and test files do exactly that.
  • [css/](css/]: Contains a CSS file used by the demo. This file is not required for using impress.js in your own presentations. Impress.js creates the CSS it needs dynamically.
  • extras/ contains plugins that for various reasons aren't enabled by default. You have to explicitly add them with their own script element to use them.
  • build.js: Simple build file that creates js/impress.js. It also creates a minified version impress.min.js, but that one is not included in the github repository.
  • package.json: An NPM package specification. This was mainly added so you can easily install buildify and run node build.js. Other than the build process (which is really just doing roughly cat src/impress.js src/plugins/*/*.js > js/impress.js) impress.js itself doesn't depend on Node or any NPM modules.
  • bower.json: A Bower package file. We also don't depend on Bower, but provide this file if you want to use it.

WANT TO CONTRIBUTE?

For developers, once you've made changes to the code, you should run these commands for testing:

npm run build
npm run test
npm run lint

Note that running firefox qunit_test_runner.html is usually more informative than running karma with npm run test. They both run the same tests.

More info about the src/ directory can be found in src/plugins/README.md.

Upstream impress.js has its own bureacracy around contributing. I welcome pull requests against this fork as well, just submit a PR on github and I'll be happy to look at it :-)

Note that if, for example, you want to add a new plugin, you should do it against this fork, since upstream impress.js doesn't have a plugin API yet. Hopefully one day the progress from this fork will trickle back to upstream repository.

ABOUT THE NAME

impress.js name in courtesy of @skuzniak.

It's an (un)fortunate coincidence that a Open/LibreOffice presentation tool is called Impress ;)

Reference API

See the Reference API

BROWSER SUPPORT

The design goal for impress.js has been to showcase awesome CSS3 features as found in modern browser versions. We also use some new DOM functionality, and specifically do not use jQuery or any other JavaScript libraries, nor our own functions, to support older browsers. In general, recent versions of Firefox and Chrome are known to work well. IE works, except there are known issues with its CSS 3D implementation, so advanced presentations won't.

The typical use case for impress.js is to create presentations that you present from your own laptop, with a browser version you know works well. Some people also use impress.js successfully to embed animations or presentations in a web page, however, be aware that in this some of your visitors may not see the presentation correctly, or at all.

In particular, impress.js makes use of the following JS and CSS features:

COPYRIGHT AND LICENSE

Copyright 2011-2016 Bartek Szopka - Released under the MIT License