Skip to content
Documentation

Installation

Install Directly

Section titled “Install Directly”
Terminal window
npm install shepherd.js --save

styles

Section titled “styles”

Don’t forget to add your styles

import 'shepherd.js/dist/css/shepherd.css';

GitHub Releases

Section titled “GitHub Releases”

Whenever we release a new version, the contents of the dist are uploaded to the release in GitHub. You can find those assets here.

jsDelivr CDN

Section titled “jsDelivr CDN”

You can use jsDelivr to pull down any release from npm. For example, you could include v10.0.1 with styles in your app with:

<script
  type="module"
  src="https://cdn.jsdelivr.net/npm/shepherd.js@17.0.0/dist/js/shepherd.mjs"
></script>
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/shepherd.js@17.0.0/dist/css/shepherd.css"
/>

JS Framework Wrappers

Section titled “JS Framework Wrappers”

We strive to make it easy to use Shepherd in all the major frameworks, and have written wrappers to facilitate this.