docusaurus-plugin-typedoc 1.0.0-next.26 → 1.0.0-next.28

package/README.md

@@ -1,6 +1,6 @@
 # docusaurus-plugin-typedoc
 
-![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
+![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
 
 A Docusaurus plugin to integrate TypeDoc into a Docusaurus project.
 
@@ -12,8 +12,4 @@ A Docusaurus plugin to integrate TypeDoc into a Docusaurus project.
 
 ## Documentation
 
-Please visit https://typedoc-plugin-markdown.org/integrations/docusaurus.
-
-## License
-
-Released under the [MIT License](./LICENSE).
+Please visit [typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org/integrations/docusaurus/introduction) for comprehensive documentation, including options and usage guides.

package/dist/plugin.js

@@ -93,7 +93,7 @@ module.exports = typedocSidebar.items;`);
             return;
         }
         console.error('[docusaurus-plugin-typedoc] TypeDoc exited with an error. Use the "skipErrorChecking" option to disable TypeDoc error checking.');
-        process.exit();
+        process.exit(1);
     }
     if (app.options.getValue('watch')) {
         app.convertAndWatch(async (project) => {

package/dist/sidebar.js

@@ -11,9 +11,20 @@ function getNavigationItem(navigationItem, basePath, filteredIds, numberPrefixPa
     const parsedUrl = numberPrefixParser === false
         ? navigationItem.url
         : navigationItem.url?.replace(/\d+\-/g, '');
-    const id = navigationItem.url
-        ? `${basePath}/${parsedUrl}`.replace(/(.*).md/, '$1')
-        : null;
+    const getId = () => {
+        const idParts = [];
+        if (basePath.length > 0) {
+            idParts.push(basePath);
+        }
+        if (parsedUrl) {
+            idParts.push(parsedUrl);
+        }
+        if (navigationItem.url) {
+            return idParts.join('/').replace(/(.*).md/, '$1');
+        }
+        return null;
+    };
+    const id = getId();
     if (navigationItem.children?.length) {
         return {
             type: 'category',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.26",
+  "version": "1.0.0-next.28",
   "description": "A Docusaurus plugin to integrate TypeDoc into a Docusaurus project.",
   "main": "dist/index.js",
   "files": [
@@ -16,15 +16,15 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.44"
+    "typedoc-plugin-markdown": ">=4.0.0-next.45"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
     "prepublishOnly": "npm run lint && npm run build",
     "build": "rm -rf ./dist && tsc",
-    "build-and-test": "npm run build && npm run test",
+    "pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
     "test": "jest",
-    "test:update": "npm test -- -u"
+    "test:update": "npm run build && npm test -- -u"
   },
   "author": "Thomas Grey",
   "license": "MIT",
@@ -37,6 +37,7 @@
     "api"
   ],
   "devDependencies": {
+    "@docusaurus/core": "^3.1.1",
     "@docusaurus/types": "^3.1.1"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Thomas Grey
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.