hevlfreis/trip.js

Trip.js is a plugin that can help you customize a tutorial trip easily with more flexibilities. ( Based on jQuery )

Trip.js

Trip.js is a jQuery plugin that can help you customize a tutorial trip easily with more flexibilities. Right now Trip.js support lots of useful stuffs like keyboard binding, animations, changing themes ... etc. If you want to highly customize your own tutorial trip, then Trip.js is definitely worth to give it a try !

Browser support

Trip.js has been tested and work well on IE 9+, Chrome 32+, Firefox 32+ and Safari 9+

Version

3.3.0

How to

Use this library

Please check website, setup, configuration and API :P

Run tests

grunt test # run all QUnit tests

Build

grunt build # build js and CSS files

grunt build-js # build only js files

grunt build-css # build only CSS files

Compile HTML

grunt html # static files that will be displayed on website

Genereate docs

grunt doc # jsdoc and our documentations

Bump version

grunt bumpversion --oldv=VERSION_FROM --newv=VERSION_TO # below is an example
grunt bumpversion --oldv=3.1.7 --newv=3.1.8 # change version number in src

grunt all # regenerate everything including docs, HTML, CSS, dist scripts

Deploy website

./update_gh_pages # this will make sure to include needed data for gh-pages branch

Special thanks

• Everyone who is engaged in this project.
• Animate.css

Support Trip.js !

If you do love Trip.js, feel free to buy me some beers ! 🍻

My bitcoin wallet : 1KtpFtaLW52tCe2VhWxCMHmRt8Mrxqj4WB

Author

Chia-Lung, Chen (EragonJ)

License

MIT