docusaurus-plugin-typedoc 1.3.0 → 1.3.1

package/README.md

@@ -6,7 +6,7 @@
 
 ## Documentation
 
-Please visit the [https://typedoc-plugin-markdown.org/plugins/docusaurus](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.
+Please visit [https://typedoc-plugin-markdown.org/plugins/docusaurus](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.
 
 ## License
 

package/dist/options/declarations.d.ts

@@ -18,5 +18,24 @@ import { DeclarationOption } from 'typedoc';
  *
  * Please see the [sidebar guide](/plugins/docusaurus/guides/sidebar) for additional information on sidebar setup.
  *
+ * ```js  filename="docusaurus.config.js"
+ * {
+ *   plugins: [
+ *     [
+ *       'docusaurus-plugin-typedoc',
+ *       {
+ *         "sidebar": {
+ *           "autoConfiguration": true,
+ *           "pretty": false,
+ *           "typescript": false,
+ *           "deprecatedItemClassName": "typedoc-sidebar-item-deprecated"
+ *         }
+ *       }
+ *     ]
+ *   ]
+ * }
+ *
+ * @omitExample
+ *
  */
 export declare const sidebar: Partial<DeclarationOption>;

package/dist/options/declarations.js

@@ -19,6 +19,25 @@ import { DEFAULT_SIDEBAR_OPTIONS } from './options.js';
  *
  * Please see the [sidebar guide](/plugins/docusaurus/guides/sidebar) for additional information on sidebar setup.
  *
+ * ```js  filename="docusaurus.config.js"
+ * {
+ *   plugins: [
+ *     [
+ *       'docusaurus-plugin-typedoc',
+ *       {
+ *         "sidebar": {
+ *           "autoConfiguration": true,
+ *           "pretty": false,
+ *           "typescript": false,
+ *           "deprecatedItemClassName": "typedoc-sidebar-item-deprecated"
+ *         }
+ *       }
+ *     ]
+ *   ]
+ * }
+ *
+ * @omitExample
+ *
  */
 export const sidebar = {
     help: 'Configures the autogenerated Docusaurus sidebar.',

package/dist/plugin/sidebar.js

@@ -7,14 +7,7 @@ export function writeSidebar(navigation, outputDir, sidebar, siteDir, docsPreset
             ? 'typedoc-sidebar.ts'
             : 'typedoc-sidebar.cjs';
         const sidebarPath = path.resolve(outputDir, sidebarFileName);
-        let baseDir = path
-            .relative(siteDir, outputDir)
-            .split(path.sep)
-            .slice(1)
-            .join('/');
-        if (docsPresetPath) {
-            baseDir = adjustBaseDirectory(baseDir, docsPresetPath);
-        }
+        const baseDir = adjustBaseDirectory(path.relative(siteDir, outputDir).split(path.sep).join('/'), docsPresetPath || 'docs');
         const sidebarJson = getSidebar(navigation, baseDir, sidebar, numberPrefixParser);
         const sidebarContent = sidebar.typescript
             ? getTypescriptSidebar(sidebarJson, sidebar)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "exports": {
     ".": "./dist/index.js"
@@ -26,7 +26,6 @@
     "prebuild": "rm -rf dist && prebuild-options && copyfiles --up 1 ./src/**/*.cjs ./dist/",
     "prepublishOnly": "npm run lint && npm run build",
     "build": "tsc",
-    "pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
     "test": "jest",
     "test:update": "npm run build && npm test -- -u"
   },
@@ -36,9 +35,5 @@
     "docusaurus",
     "typedoc",
     "plugin"
-  ],
-  "devDependencies": {
-    "@docusaurus/core": "^3.7.0",
-    "@docusaurus/types": "^3.7.0"
-  }
+  ]
 }