intro.js

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

Github星跟蹤圖

Intro.js v2.9.3

Build Status

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.

Release History

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

主要指標

概覽
名稱與所有者usablica/intro.js
主編程語言TypeScript
編程語言JavaScript (語言數: 8)
平台
許可證Other
所有者活动
創建於2013-03-10 15:12:45
推送於2025-04-21 09:27:03
最后一次提交2025-04-21 10:26:57
發布數51
最新版本名稱v8.2.0-beta.1 (發布於 )
第一版名稱v0.1.0 (發布於 2013-03-15 15:13:11)
用户参与
星數23k
關注者數449
派生數2.6k
提交數1.6k
已啟用問題?
問題數828
打開的問題數53
拉請求數432
打開的拉請求數25
關閉的拉請求數780
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?