[deploy_website] follow typedoc's compatible typescript versiobn

.github/workflows/website.yml

@@ -39,8 +39,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-16-node-modules-${{ hashFiles('yarn.lock') }}
             ${{ runner.os }}-16-node-modules-
+      - name: Align TypeScript version with typedoc
+        run: node scripts/install-typedocs-typescript-version.js
       - name: Install Dependencies using Yarn
-        run: yarn install && git checkout yarn.lock
+        run: yarn install && git checkout yarn.lock && git checkout package.json
       - name: Deploy 🚀
         run: yarn deploy:website
         env:

renovate.json

@@ -6,5 +6,6 @@
   "major": {
     "automerge": false
   },
-  "labels": ["dependencies"]
+  "labels": ["dependencies"],
+  "ignoreDeps": ["typedoc-plugin-markdown"]
 }

scripts/install-typedocs-typescript-version.js

@@ -0,0 +1,16 @@
+const { writeFileSync } = require('fs');
+const { resolve } = require('path');
+const { argv, cwd } = require('process');
+
+const typeDocsVersion = require('typedoc/package.json');
+const pkgPath = resolve(cwd(), './package.json');
+
+const pkg = require(pkgPath);
+
+const version = argv[2];
+
+pkg.resolutions = pkg.resolutions || {};
+
+pkg.resolutions.typescript = typeDocsVersion.peerDependencies.typescript;
+
+writeFileSync(pkgPath, JSON.stringify(pkg, null, 2), 'utf8');

website/docs/cache/localforage.md

@@ -24,4 +24,4 @@ cache:
 
 ## Config API Reference
 
-{@import ../generated-markdown/Localforage.generated.md}
+{@import ../generated-markdown/LocalforageConfig.generated.md}

website/docs/cache/redis.md

@@ -1,7 +1,7 @@
 ---
-id: cache-file
-title: File Cache
-sidebar_label: File
+id: cache-redis
+title: Redis Cache
+sidebar_label: Redis
 ---
 
 This caching strategy will use your Redis instance as the storage.

website/sidebars.js

@@ -37,9 +37,9 @@ module.exports = {
     ],
     Cache: [
       'cache/inmemory-lru',
-      'cache/file',
+      'cache/cache-file',
       'cache/localforage',
-      'cache/redis'
+      'cache/cache-redis'
     ],
     Recipes: [
       'recipes/typescript',