feat: doc website: add MultiversX; upgrade to latest typedoc, docusau…

…rus.
logion-network · Oct 30, 2023 · 62da06c · 62da06c
1 parent 119532f
commit 62da06c
Show file tree

Hide file tree

Showing 14 changed files with 299 additions and 280 deletions.
diff --git a/packages/client/package.json b/packages/client/package.json
@@ -54,9 +54,5 @@
   "engines": {
     "node": ">=18"
   },
-  "stableVersion": "0.2.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Client"
-  }
+  "stableVersion": "0.2.0"
 }
diff --git a/packages/client/typedoc.json b/packages/client/typedoc.json
@@ -0,0 +1,6 @@
+{
+  "name": "Client",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}
diff --git a/packages/crossmint/package.json b/packages/crossmint/package.json
@@ -43,9 +43,5 @@
   "engines": {
     "node": ">=16"
   },
-  "stableVersion": "0.1.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Crossmint"
-  }
+  "stableVersion": "0.1.0"
 }
diff --git a/packages/crossmint/typedoc.json b/packages/crossmint/typedoc.json
@@ -0,0 +1,6 @@
+{
+  "name": "Crossmint",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}
diff --git a/packages/extension/package.json b/packages/extension/package.json
@@ -44,9 +44,5 @@
   "engines": {
     "node": ">=16"
   },
-  "stableVersion": "0.1.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Extension"
-  }
+  "stableVersion": "0.1.0"
 }
diff --git a/packages/extension/typedoc.json b/packages/extension/typedoc.json
@@ -0,0 +1,6 @@
+{
+  "name": "Extension",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}
diff --git a/packages/multiversx/package.json b/packages/multiversx/package.json
@@ -44,9 +44,5 @@
   "engines": {
     "node": ">=16"
   },
-  "stableVersion": "0.1.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "MultiversX"
-  }
+  "stableVersion": "0.1.0"
 }
diff --git a/packages/multiversx/typedoc.json b/packages/multiversx/typedoc.json
@@ -0,0 +1,6 @@
+{
+  "name": "MultiversX",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}
diff --git a/packages/node-api/package.json b/packages/node-api/package.json
@@ -70,9 +70,5 @@
   "engines": {
     "node": ">=18"
   },
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Node API"
-  },
   "type": "module"
 }
diff --git a/packages/node-api/typedoc.json b/packages/node-api/typedoc.json
@@ -0,0 +1,6 @@
+{
+  "name": "Node API",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}
diff --git a/website/package.json b/website/package.json
@@ -16,20 +16,19 @@
     "api-doc": "typedoc"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.0",
-    "@docusaurus/preset-classic": "^2.4.0",
+    "@docusaurus/core": "^2.4.3",
+    "@docusaurus/preset-classic": "^2.4.3",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
     "prism-react-renderer": "^1.3.5",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.4.0",
-    "@tsconfig/docusaurus": "^1.0.5",
-    "typedoc": "^0.23.20",
-    "typedoc-plugin-markdown": "^3.13.6",
-    "typedoc-plugin-resolve-crossmodule-references": "^0.3.2",
+    "@docusaurus/module-type-aliases": "^2.4.3",
+    "@tsconfig/docusaurus": "^2.0.2",
+    "typedoc": "^0.25.3",
+    "typedoc-plugin-markdown": "^3.16.0",
     "typescript": "^4.7.4"
   },
   "browserslist": {

diff --git a/website/src/API.md b/website/src/API.md
@@ -7,4 +7,5 @@
 - [Client](modules/Client.md)
 - [Crossmint](modules/Crossmint.md)
 - [Extension](modules/Extension.md)
+- [MultiversX](modules/MultiversX.md)
 - [Node API](modules/Node_API.md)
diff --git a/website/typedoc.json b/website/typedoc.json
@@ -1,13 +1,14 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "out": "docs/api",
-  "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-resolve-crossmodule-references"],
+  "plugin": ["typedoc-plugin-markdown"],
   "excludeExternals": false,
   "entryPointStrategy": "packages",
   "entryPoints": [
     "../packages/client",
     "../packages/crossmint",
     "../packages/extension",
+    "../packages/multiversx",
     "../packages/node-api"
   ],
   "readme": "src/API.md",