• Stars
    star
    11,579
  • Rank 2,707 (Top 0.06 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 10 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Guide your users through a tour of your app

Shepherd.js Logo

npm version Download count all time npm FOSSA Status npm bundle size Test Maintainability Test Coverage StackShare

Guide your users through a tour of your app

Browsers support

IE / Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
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

Shepherd Pro allows you to use the same JS library and add enhanced analytics to your tours while letting you also connect some integrations to deepen the knowledge and effectiveness of those user experiences.

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

FOSSA Status

More Repositories

1

tether

A positioning engine to make overlays, tooltips and dropdowns better
JavaScript
8,493
star
2

react-shepherd

A React wrapper for the site tour library Shepherd
CSS
549
star
3

vue-shepherd

A Vue wrapper for the site tour library Shepherd
Vue
260
star
4

angular-shepherd

An Angular wrapper for the site tour library Shepherd
TypeScript
196
star
5

ember-cli-release

Ember CLI addon for versioned release management
JavaScript
90
star
6

swach

A robust color management tool for the modern age
TypeScript
46
star
7

ember-prism

Easy ember components for syntax highlighting a-la PrismJS
JavaScript
34
star
8

ember-cli-capacitor

Add Capacitor to your Ember app.
JavaScript
28
star
9

ember-x-editable

X-editable like library for Ember
JavaScript
22
star
10

ember-3d-nav

A 3d rotating top navigation bar for Ember apps
JavaScript
22
star
11

website-ember

The code for shipshape.io
JavaScript
20
star
12

website-nuxt

Nuxt port of shipshape.io
Vue
16
star
13

ember-cli-netlify

Ember addon to configure Netlify headers and redirects
JavaScript
14
star
14

ember-drop

An Ember addon that wraps Drop.js
JavaScript
11
star
15

prember-sitemap-generator

A sitemap generator for prember apps
JavaScript
6
star
16

ember-service-worker-prember

An Ember Service Worker plugin that caches the index.html files for each prember route
JavaScript
6
star
17

website-astro

The code for the current Ship Shape website
Astro
5
star
18

ember-3d-folding-panel

An Ember addon for 3d folding panels
JavaScript
5
star
19

ember-performance-workshop

The code for the EmberConf 2018 Performance Workshop
HTML
4
star
20

ember-newton-cradle-loader

Ember addon for showing a newton cradle loading animation
JavaScript
4
star
21

ember-headroom

Ember addon to include headroom.js as an ES2015 module in your app
JavaScript
4
star
22

ember-async-await-for-each

async/await aware forEach for Ember
JavaScript
4
star
23

prember-rss-feed

Ship RSS feeds for your Prember site
JavaScript
3
star
24

ember-assign-polyfill

A polyfill for Ember.assign in <= 2.4
JavaScript
2
star
25

ember-journal

A blogging engine for Ember apps
JavaScript
2
star
26

ember-isometric-grids

JavaScript
2
star
27

bootcamp-loader

TypeScript
1
star
28

1787-astro

Astro
1
star
29

ember-debonair

Get your Ember code in ship shape
JavaScript
1
star
30

ember-showdown-highlight

JavaScript
1
star
31

glimmer-context-menu

TypeScript
1
star
32

www-website

whiskeywebandwhatnot.fm
JavaScript
1
star