Docs (#246)

Author: MatthijsBurgh

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Docs Deployment
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  docs:
+    name: Docs Deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+          node-version: 18
+      - name: Install
+        run: npm ci
+      - name: Generate docs
+        run: npm run doc
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: doc
+          destination_dir: .
+          enable_jekyll: false
+          force_orphan: false  # So we keep the doc history
+          commit_message: JSDoc ${{ github.event.release.name }}

.github/workflows/main.yml

@@ -13,6 +13,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
+          cache: npm
           node-version: ${{ matrix.node-version }}
       - name: Install
         run: npm ci

.github/workflows/npm-publish.yml

@@ -1,4 +1,4 @@
-name: Deployment
+name: NPM Deployment
 
 on:
   push:
@@ -13,6 +13,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
+          cache: npm
           node-version: 18
           registry-url: 'https://registry.npmjs.org'
       - name: Install

.gitignore

@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+# JSDoc output
+doc

jsdoc_conf.json

@@ -0,0 +1,17 @@
+{
+  "plugins": ["plugins/markdown"],
+  "markdown": {
+    "parser": "gfm"
+  },
+  "source": {
+    "include": ["README.md", "src"],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "opts": {
+    "template": "templates/default",  // same as -t templates/default
+    "encoding": "utf8",               // same as -e utf8
+    "destination": "doc",
+    "recurse": true
+  }
+}