shepherd.js - npm Package Compare versions

Comparing version 2.0.0-beta.2 to 2.0.0-beta.3

docs/intro.md

@@ -1,4 +0,5 @@
-<link rel="stylesheet" href="/shepherd/dist/css/shepherd-theme-arrows.css" />
-<script src="/shepherd/dist/js/popper.js"></script>
-<script src="/shepherd/dist/js/shepherd.min.js"></script>
+<link rel="stylesheet" href="ocean.css" />
+<link rel="stylesheet" href="/dist/css/shepherd-theme-arrows.css" />
+<script src="/dist/js/popper.js"></script>
+<script src="/dist/js/shepherd.min.js"></script>
 
@@ -13,2 +14,14 @@ ## Shepherd
 
+### Install 
+
+```bash
+npm install shepherd.js --save
+```
+
+or
+
+```bash
+yarn add shepherd.js
+```
+
 ### Install with Eager
@@ -169,3 +182,3 @@
 ```
-- `tetherOptions`: Extra options to pass to [tether](http://github.hubspot.com/tether)
+- `popperOptions`: Extra options to pass to [popper.js](https://github.com/FezVrasta/popper.js)
 
@@ -172,0 +185,0 @@ ##### Step Methods

docs/welcome/js/welcome.js

@@ -35,3 +35,3 @@ (function() {
       text: 'Including Shepherd is easy! Just include popper.js, shepherd.js, and a Shepherd theme file.',
-      attachTo: '#hero-including-code left',
+      attachTo: '#hero-including-code bottom',
       buttons: [
@@ -51,3 +51,3 @@ {
       text: 'Creating a Shepherd is easy too! Just create Shepherd and add as many steps as you want. Check out the <a href="http://github.hubspot.com/shepherd">documentation</a> to learn more.',
-      attachTo: '#hero-example-code right',
+      attachTo: '#hero-example-code bottom',
       buttons: [
@@ -54,0 +54,0 @@ {

gulpfile.js

@@ -7,2 +7,4 @@ const del = require('del');
 const header = require('gulp-header');
+const hljs = require('highlight.js');
+const markdown = require('gulp-markdown');
 const prefixer = require('gulp-autoprefixer');
@@ -63,2 +65,23 @@ const rename = require('gulp-rename');
 
+gulp.task('markdown:docs', () => {
+  gulp.src('./docs/intro.md')
+    .pipe(
+      markdown({
+        highlight: function(code, lang) {
+          if (!lang) {
+            return code;
+          }
+          return hljs.highlight(lang, code).value;
+        }
+      })
+    )
+    .pipe(rename(function(path) {
+      path.extname = '.html';
+    }))
+    .pipe(gulp.dest('./docs/'));
+
+  gulp.src('./node_modules/highlight.js/styles/ocean.css')
+    .pipe(gulp.dest('./docs'));
+});
+
 gulp.task('css:docs', function() {
@@ -71,2 +94,4 @@ gulp.src('./docs/welcome/sass/*.sass')
 
+gulp.task('docs', ['css:docs', 'markdown:docs']);
+
 // Make a copy of popper available to those not using bundling
@@ -110,4 +135,4 @@ gulp.task('copy-popper', function() {
 // Defaults
-gulp.task('build', ['js', 'css', 'eager', 'copy-popper']);
+gulp.task('build', ['js', 'css', 'eager', 'copy-popper', 'docs']);
 gulp.task('default', ['build']);
 

package.json

 {
   "name": "shepherd.js",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "repository": {
@@ -43,6 +43,8 @@ "type": "git",
     "gulp-header": "^2.0.5",
+    "gulp-markdown": "^2.0.1",
     "gulp-rename": "^1.3.0",
     "gulp-sass": "^4.0.1",
     "gulp-uglify-es": "^1.0.4",
-    "gulp-wrap-umd": "^0.2.1"
+    "gulp-wrap-umd": "^0.2.1",
+    "highlight.js": "^9.12.0"
   },
@@ -49,0 +51,0 @@ "engines": {

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

348667

decreased by-33.39%

Dev dependency count

17

increased by13.33%

Number of package files

30

decreased by-30.23%

Lines of code

1377

decreased by-75.05%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes