Start on TS support for JSDoc

.github/workflows/publish-github-pages.yml

@@ -29,8 +29,8 @@ jobs:
         run: |
           pnpm i
           pnpm build
-      # - name: Build docs
-      #   run: pnpm run docs
+      - name: Build docs
+        run: pnpm run docs
       - name: Publish site and docs
         uses: peaceiris/actions-gh-pages@v3
         with:

.jsdoc.js

@@ -8,16 +8,24 @@ module.exports = {
   source: {
     include: [
       'package.json',
-      'README.md',
       './src/shepherd.ts',
       './src/step.ts',
       './src/tour.ts'
-    ]
+    ],
+    includePattern: '\\.(json|js|ts)$'
   },
-  plugins: [
-    'plugins/markdown'
-  ],
+  plugins: ['plugins/markdown', 'node_modules/better-docs/typescript'],
   sourceType: 'module',
+  opts: {
+    destination: './site/docs/',
+    encoding: 'utf8',
+    // Do not include functions marked `@private`
+    private: false,
+    readme: 'README.md',
+    recurse: true,
+    template: './node_modules/jsdoc-template-ship-shape',
+    tutorials: './docs-src/tutorials'
+  },
   templates: {
     referenceTitle: 'Shepherd.js',
     favicon: '/landing/public/favicons/favicon-32x32.png',
@@ -28,15 +36,18 @@ module.exports = {
     collapse: false,
     resources: {
       Demo: 'https://shepherdjs.dev/'
+    },
+    'better-docs': {
+      navLinks: [
+        {
+          label: 'Demo',
+          href: 'https://shepherdjs.dev/'
+        },
+        {
+          label: 'GitHub',
+          href: 'https://github.com/shepherd-pro/shepherd'
+        }
+      ]
     }
-  },
-  opts: {
-    destination: './site/docs/',
-    encoding: 'utf8',
-    // Do not include functions marked `@private`
-    private: false,
-    recurse: true,
-    template: './node_modules/jsdoc-template-ship-shape',
-    tutorials: './docs-src/tutorials'
   }
 };

package.json

@@ -34,6 +34,7 @@
     "@release-it-plugins/lerna-changelog": "^6.1.0",
     "@release-it-plugins/workspaces": "^4.2.0",
     "autoprefixer": "^10.4.16",
+    "better-docs": "^2.7.3",
     "cypress": "^13.6.2",
     "cypress-plugin-tab": "^1.0.5",
     "del": "^7.1.0",