We strive to make it easy to use Shepherd in all the major frameworks, and have written wrappers to facilitate this.
Dependencies
Installing via npm will bring in the above dependencies as well.
npm
npm install shepherd.js --saveyarn
yarn add shepherd.jslet tour = new Shepherd.Tour({
defaultStepOptions: {
classes: 'shadow-md bg-purple-dark',
scrollTo: true
}
});
tour.addStep('example', {
title: 'Example Shepherd',
text: 'Creating a Shepherd is easy too! Just create ...',
attachTo: '.hero-example bottom',
advanceOn: '.docs-link click'
});
tour.start();We encourage contributions of all kinds. If you would like to contribute in some way, please review our guidelines for contributing.