Pkspyder007 jsdoc action

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: jsdocs-action
+        uses: andstor/[email protected]
+        with:
+          source_dir: ./src
+          output_dir: ./out
+          config_file: ./conf.json
+          template: better-docs
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./out

.gitignore

@@ -82,6 +82,9 @@ web_modules/
 .nuxt
 dist
 
+# docs
+out
+
 # Gatsby files
 .cache/
 # Comment in the public line in if your project uses Gatsby and not Next.js

conf.json

@@ -0,0 +1,18 @@
+{
+  "tags": {
+      "allowUnknownTags": true
+  },
+  "source": {
+      "includePattern": ".+\\.js(doc|x)?$",
+      "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "plugins": ["node_modules/jsdoc-export-default-interop/dist/index",
+              "node_modules/better-docs/category"],
+  "templates": {
+      "cleverLinks": true,
+      "monospaceLinks": false,
+      "default": {
+          "outputSourceFiles": true
+      }
+  }
+}