旧版报表、仓库
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

107 lines
3.6 KiB

2 years ago
# Intro.js v2.9.3
[![Build Status](https://travis-ci.org/usablica/intro.js.svg?branch=master)](https://travis-ci.org/usablica/intro.js)
> 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](http://www.jsdelivr.com/projects/intro.js), [2](https://cdnjs.com/libraries/intro.js))
## 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](http://www.jsdelivr.com/projects/intro.js) (click Show More) & [cdnjs](https://cdnjs.com/libraries/intro.js).
**2)** Add `data-intro` and `data-step` to your HTML elements. To add hints you should use `data-hint` attribute.
For example:
```html
<a href='http://google.com/' data-intro='Hello step one!'></a>
````
See all attributes [here](https://introjs.com/docs/intro/attributes/).
**3)** Call this JavaScript function:
```javascript
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'`.
<p align="center"><img src="https://raw.githubusercontent.com/usablica/intro.js/gh-pages/img/introjs-demo.png"></p>
## Documentation
Please visit [Documentation](http://introjs.com/docs).
## Using with:
Intro.js has many wrappers for different purposes. Please visit [Documentation](http://introjs.com/docs) 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.
<p align="center">
<a target='_blank' href="http://www.packtpub.com/create-useful-introductions-for-websites-and-applications-with-introjs-library/book"><img src='http://dgdsbygo8mp3h.cloudfront.net/sites/default/files/imagecache/productview_larger/2517OS_Instant%20IntroJS%20Starter.jpg' /></a>
</p>
<p align="center">
<a target='_blank' href="http://www.packtpub.com/create-useful-introductions-for-websites-and-applications-with-introjs-library/book">Buy and Download</a>
</p>
## <a href="https://github.com/usablica/intro.js/blob/master/changelog.md">Release History</a>
## Authors
**Afshin Mehrabani**
- [Twitter](https://twitter.com/afshinmeh)
- [Github](https://github.com/afshinm)
- [Personal page](http://afshinm.name/)
**Benjamin J DeLong**
- [Twitter](https://twitter.com/bozdoz)
- [Github](https://github.com/bozdoz)
- [Personal page](https://bozdoz.com/)
[Other contributors](https://github.com/usablica/intro.js/graphs/contributors)
## Contributing
View [contribution guidlines](https://github.com/usablica/intro.js/blob/master/CONTRIBUTING.md)
## Support/Discussion
- [Stackoverflow](http://stackoverflow.com/questions/tagged/intro.js)
## 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](http://introjs.com/#commercial)
### Open-source license
GNU AGPLv3