Merge pull request #2698 from GabrielBdeC/fix/docs

fix: typedocs
orkestral · Apr 8, 2024 · cb5102e · cb5102e
2 parents b3d5313 + cefdd99
commit cb5102e
Show file tree

Hide file tree

Showing 43 changed files with 15 additions and 1,592 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -18,9 +18,8 @@
     "changelog:update": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "clean": "shx rm -rf session dist",
     "commit": "cz",
-    "fix:doc-theme": "shx cp ./node_modules/typedoc-default-themes/bin/default/partials/type.hbs ./node_modules/typedoc-plugin-pages/dist/theme/v2/partials/type.hbs",
     "fix:imports": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\" && npm run lint:fix",
-    "generate-api-docs": "npm run fix:doc-theme && typedoc",
+    "generate-api-docs": "typedoc",
     "lint:js": "npx eslint -c .eslintrc.cjs --ext .js src",
     "lint:ts": "npx eslint -c .eslintrc.cjs --ext .ts src",
     "lint": "npm run lint:ts && npm run lint:js",
@@ -109,9 +108,8 @@
     "release-it": "^16.1.0",
     "shx": "^0.3.4",
     "ts-loader": "^9.5.1",
-    "typedoc": "^0.25.7",
+    "typedoc": "^0.25.12",
     "typedoc-default-themes": "^0.12.10",
-    "typedoc-plugin-pages": "^1.1.0",
     "typescript": "^5.3.3",
     "webpack": "^5.89.0",
     "webpack-cli": "^5.0.1"

diff --git a/typedoc.json b/typedoc.json
@@ -6,27 +6,6 @@
   "excludeProtected": true,
   "includeVersion": true,
   "out": "api-docs",
-  "theme": "pages-plugin",
-  "media": "media",
-  "pages": {
-    "groups": [
-      {
-        "title": "Getting Started",
-        "pages": [
-          {
-            "title": "Installation",
-            "source": "./docs/getting-started/installation.md"
-          },
-          {
-            "title": "Creating a Client",
-            "source": "./docs/getting-started/creating-client.md"
-          },
-          {
-            "title": "Basic Functions",
-            "source": "./docs/getting-started/basic-functions.md"
-          }
-        ]
-      }
-    ]
-  }
+  "theme": "default",
+  "media": "media"
 }
diff --git a/venom-docs/.gitignore b/venom-docs/.gitignore
diff --git a/venom-docs/README.md b/venom-docs/README.md
diff --git a/venom-docs/babel.config.js b/venom-docs/babel.config.js
diff --git a/venom-docs/blog/2019-05-28-first-blog-post.md b/venom-docs/blog/2019-05-28-first-blog-post.md
diff --git a/venom-docs/blog/2019-05-29-long-blog-post.md b/venom-docs/blog/2019-05-29-long-blog-post.md
diff --git a/venom-docs/blog/2021-08-01-mdx-blog-post.mdx b/venom-docs/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/venom-docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/venom-docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/venom-docs/blog/2021-08-26-welcome/index.md b/venom-docs/blog/2021-08-26-welcome/index.md
diff --git a/venom-docs/blog/authors.yml b/venom-docs/blog/authors.yml
diff --git a/venom-docs/docs/intro.md b/venom-docs/docs/intro.md
diff --git a/venom-docs/docs/tutorial-basics/_category_.json b/venom-docs/docs/tutorial-basics/_category_.json
diff --git a/venom-docs/docs/tutorial-basics/congratulations.md b/venom-docs/docs/tutorial-basics/congratulations.md