Skip to content

A better way for new feature introduction and step-by-step users guide for your website and project.

License

Notifications You must be signed in to change notification settings

yassine-mahjoubi/intro.js

This branch is 919 commits behind usablica/intro.js:master.

Folders and files

NameName
Last commit message
Last commit date
Dec 5, 2017
Jun 25, 2017
Dec 2, 2017
Dec 2, 2017
Dec 2, 2017
Dec 10, 2016
Jul 29, 2017
Oct 8, 2017
May 19, 2014
Oct 31, 2017
Aug 14, 2017
Aug 14, 2017
Oct 31, 2017
Dec 2, 2017
Sep 1, 2016
Dec 2, 2017
Dec 2, 2017
Dec 2, 2017
May 28, 2017
Oct 3, 2017
Jul 29, 2017
Oct 31, 2017
Dec 2, 2017
Dec 21, 2016

Repository files navigation

Intro.js v2.9.0

Better introductions for websites and features with a step-by-step guide for your projects.

Where to get

You can obtain your local copy of Intro.js from:

1) This github repository, using git clone https://github.com/usablica/intro.js.git

2) Using bower bower install intro.js --save

3) Using npm npm install intro.js --save

4) Download it from CDN (1, 2)

How to use

Intro.js can be added to your site in three simple steps:

1) Include intro.js and introjs.css (or the minified version for production) in your page. Use introjs-rtl.min.css for Right-to-Left language support.

CDN hosted files are available at jsDelivr (click Show More) & cdnjs.

2) Add data-intro and data-step to your HTML elements. To add hints you should use data-hint attribute.

For example:

<a href='http://google.com/' data-intro='Hello step one!'></a>

See all attributes here.

3) Call this JavaScript function:

introJs().start();

Optionally, pass one parameter to introJs function to limit the presentation section.

For example introJs(".introduction-farm").start(); runs the introduction only for elements with class='introduction-farm'.

Documentation

Please visit Documentation.

Using with:

Intro.js has many wrappers for different purposes. Please visit Documentation for more info.

Build

First you should install nodejs and npm, then first run this command: npm install to install all dependencies.

Now you can run this command to minify all static resources:

make build

Instant IntroJs

Want to learn faster and easier? Here we have Instant IntroJs, Packt Publishing.

Buy and Download

Authors

Afshin Mehrabani

Benjamin J DeLong

Other contributors

Contributing

View contribution guidlines

Support/Discussion

License

Commercial license

If you want to use Intro.js for a commercial application, theme or plugin the commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase a commercial license at introjs.com

Open-source license

GNU AGPLv3

About

A better way for new feature introduction and step-by-step users guide for your website and project.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 47.9%
  • JavaScript 34.9%
  • CSS 16.7%
  • Other 0.5%