Implement typedoc-plugin-versions

.github/workflows/publish-docs.yml

@@ -9,9 +9,20 @@ jobs:
   deploy-docs:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
+      - name: Checkout main
         uses: actions/checkout@v3
 
+      - name: Checkout gh-pages
+        uses: actions/checkout@v3
+        with:
+          ref: gh-pages
+          path: "./gh-pages"
+
+      - name: Fix folder structure
+        run: |
+          mv gh-pages/docs docs
+          rm -rf gh-pages
+
       - name: Setup node.js @ 16
         uses: actions/setup-node@v3
         with:
@@ -42,13 +53,11 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Check build compiles
-        run: npm run build
-
       - name: Generate API reference
         run: npm run docs
 
       - name: Publish to GitHub Pages 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: docs
+          target-folder: docs

package.json

@@ -47,6 +47,7 @@
     "ts-jest": "^28.0.8",
     "typed-emitter": "^2.1.0",
     "typedoc": "^0.23.10",
+    "typedoc-plugin-versions": "^0.1.0",
     "typescript": "^4.7.4"
   },
   "files": [

typedoc.json

@@ -1,6 +1,5 @@
 {
-  "exclude": "**/*+(.spec|.test).ts",
   "entryPoints": "src",
-  "out": "docs",
-  "entryPointStrategy": "expand"
+  "entryPointStrategy": "expand",
+  "includeVersion": "true"
 }