Merge pull request #13 from erikyo/jsdocs

Create jsDoc.yml

.github/workflows/jsDoc.yml

@@ -0,0 +1,20 @@
+name: JSDoc Action
+
+on:
+  release:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Build
+      uses: andstor/jsdoc-action@v1
+      with:
+        source_dir: ./lib
+        recurse: true
+        output_dir: ./docs
+        config_file: jsdoc.json
+        front_page: readme.md
+

jsdoc.json

@@ -0,0 +1,27 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc"]
+  },
+  "typescript": {
+    "moduleRoot": "lib"
+  },
+  "source": {
+    "include": ["lib", "package.json", "README.md"],
+    "includePattern": "\\.(jsx|js|ts|tsx)$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "opts": {
+    "encoding": "utf8",
+    "destination": "docs",
+    "readme": "./readme.md",
+    "recurse": true
+  },
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": true,
+    "useLongnameInNav": false,
+    "showInheritedInNav": true
+  }
+}
+