Skip to content

install.mdx

Latest commit

 

History

History
72 lines (57 loc) · 1.75 KB

install.mdx

File metadata and controls

72 lines (57 loc) · 1.75 KB
title Installation

import { Tabs, TabItem } from '@astrojs/starlight/components';

:::note[License Information] Shepherd.js is free for open source and non-commercial use under AGPL-3.0. Commercial projects require a commercial license. Learn more about licensing → :::

Install Directly

```bash npm install shepherd.js --save ``` ```bash yarn add shepherd.js ``` ```bash pnpm add shepherd.js ``` ```bash bun add shepherd.js ```

styles

Don't forget to add your styles

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

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

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

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