README

impress.js
============



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
---------------
 Getting Started Guide
Check out our new Getting Started guide if you want a quick introduction to the project!

 Direct download link to only impress.js
You can include this link directly inside of your HTML file in its header. If you want to learn how to do this, you can find a how-to in the Getting Started guide.
- V2.0.0: https://cdn.jsdelivr.net/gh/impress/[email protected]/js/impress.js
- V1.1.0: https://cdn.jsdelivr.net/gh/impress/[email protected]/js/impress.js
- Source: https://cdn.jsdelivr.net/gh/impress/impress.js/js/impress.js

 Getting Started Guide
Check out our new Getting Started guide if you want a quick introduction to the project!

 Checking out and initializing the git repository

    git clone --recursive https://github.com/impress/impress.js.git
    cd 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 the Github Releases page.


 Documentation


Reference documentation of core 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 explaining 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. 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 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.

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

 Mailing list

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


REPOSITORY STRUCTURE
--------------------

 index.html: This is the official impress.js demo, showcasing all

Top issues

Latest release

This release includes new features and fixes since Apr 11, 2020, when v1.1.0 was released.

Major features and improvements:

 The default target resolution used inside impress.js code for various layout and transformations, is now 1920x1080 (Full HD). In addition the max scale factor by default is now 3 x the default, meaning for larger resolutions, impress.js will stretch the slide contents to fill the available screen.
   NOTE: This change may affect your layout if you've used the default target resolution in your presentations. See DOCUMENTATION.md for how to explicitly set the wanted