Repository files navigation

It's a presentation framework based on the power of CSS3 transforms andtransitions 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 ;)

git clone --recursive https://github.com/impress/impress.js.gitcd impress.js

Note: For a minimal checkout, omit the--recursive option. This will leave out extra plugins.

Stable releases

New features and fixes are continuously merged into the master branch, which is what the above command will check out. For the latest stable release, see theGithub Releases page.

Reference documentation of core impress.js features and API you can find it inDOCUMENTATION.md.

TheHTML source code of the officialimpress.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 intoCSS code which shows how classes provided by impress.js can be used. Last but not leastJavaScript code of impress.js has some useful comments if you are interested in how everything works. Feel free to explore!

impress.js demo by@bartaz

TheClassic Slides demo is targeted towards beginners, or can be used as a template for presentations that look like the traditional PowerPoint slide deck. Over time, it also grew into the example presentation that uses most of the features and addons available.

More examples and demos can be found onExamples and demos wiki page.

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

If you want to learn even more there is alist of tutorials and other learning resourceson the wiki, too.

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

You may want to check out the sibling projectImpressionist: a 3D GUI editor that can help you in creating impress.js presentations.

You're welcome to ask impress.js related questions on theimpressionist-presentations mailing list.

• 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 official tutorial.
• examples/: Contains several demos showcasing additional features available.
  • Classic Slides is a simple demo that that you can use as template if you want to create very simple, rectangular, PowerPoint-like presentations.
• src/: The main file issrc/impress.js. Additional functionality is implemented as plugins insrc/plugins/.
  • Seesrc/plugins/README.md for information about the plugin API and how to write 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/: Containsjs/impress.js, which contains a concatenation of the coresrc/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/: Contains a CSS file used by the demo. This file isnot 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 ownscript element to use them.
• build.js: Simple build file that createsjs/impress.js. It also creates a minified versionimpress.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 installbuildify and runnode build.js. Other than the build process, which is really just doing roughlycat src/impress.js src/plugins/*/*.js > js/impress.js, and testing,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.

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

npm installnpm run buildnpm run testnpm run lint

Note that runningfirefox qunit_test_runner.html is usually more informative than runningkarma withnpm run test. They both run the same tests.

More info about thesrc/ directory can be found insrc/plugins/README.md.

• >= node 7.6
• npm

impress.js name iscourtesy of @skuzniak.

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

See theReference API

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. Reportedly IE now works too.

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:

• DataSet API
• ClassList API
• CSS 3D Transforms
• CSS Transitions

Copyright 2011-2016 Bartek Szopka

Copyright 2015-2017 Henrik Ingo

Released under the MITLicense