Browsers support
Edge | Firefox | Chrome | Safari |
---|
Edge | last 2 versions | last 2 versions | last 2 versions |
Documentation
API documentation
Demo
Demo
Contributing
We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.
Releasing
Our release process is mostly automated. For more details, see RELEASE.md.
License
MIT License
Projects Using Shepherd
Here we showcase some of the awesome libraries built using Shepherd.
JS Framework Wrappers
Ember addon for the site tour library Shepherd
An Angular wrapper for the site tour library Shepherd
A React wrapper for the site tour library Shepherd
A Vue wrapper for the site tour library Shepherd
Rails gems
Rails engine that generates and tracks Shepherd tours within an application
Websites and Apps
SimplePlanner uses Shepherd to help new users get familiar with its collaborative scheduling approach.
You do need to sign up via OAuth or email to see the scheduling tour.
Check out the Envato Tuts+ Startup Series on its codebase which describes how Simple Planner was built.
LogSeq uses Shepherd to guide users through initial setup steps.
Snapsure uses Shepherd to help photographers learn how to set up alerts for their desired picture-perfect weather conditions.
The Drupal CMS uses Shepherd to offer tours of it's core modules, and allows developers to add Tours to their custom and contributed modules.
Budibase is an open source application which allows you develop low code applications rapidly and efficiently.This Budibase Shepherd tour plugin allows you to create interative walkthroughs for your application.
Your Project Here
If you have a cool open-source library built on Shepherd, PR this doc.
License