docusaurus-plugin-typedoc - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

dist/options/declarations.d.ts

@@ -21,3 +21,22 @@ import { DeclarationOption } from 'typedoc';
  *
+ * ```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>;

dist/options/declarations.js

@@ -22,2 +22,21 @@ import { ParameterType } from 'typedoc';
  *
+ * ```js  filename="docusaurus.config.js"
+ * {
+ *   plugins: [
+ *     [
+ *       'docusaurus-plugin-typedoc',
+ *       {
+ *         "sidebar": {
+ *           "autoConfiguration": true,
+ *           "pretty": false,
+ *           "typescript": false,
+ *           "deprecatedItemClassName": "typedoc-sidebar-item-deprecated"
+ *         }
+ *       }
+ *     ]
+ *   ]
+ * }
+ *
+ * @omitExample
+ *
  */
@@ -24,0 +43,0 @@ export const sidebar = {

dist/plugin/sidebar.js

@@ -10,10 +10,3 @@ import * as fs from 'fs';
         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);
@@ -20,0 +13,0 @@ const sidebarContent = sidebar.typescript

package.json

 {
   "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.",
@@ -29,3 +29,2 @@ "exports": {
     "build": "tsc",
-    "pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
     "test": "jest",
@@ -40,7 +39,3 @@ "test:update": "npm run build && npm test -- -u"
     "plugin"
-  ],
-  "devDependencies": {
-    "@docusaurus/core": "^3.7.0",
-    "@docusaurus/types": "^3.7.0"
-  }
+  ]
 }

README.md

@@ -9,3 +9,3 @@ # docusaurus-plugin-typedoc
 
-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.
 
@@ -12,0 +12,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

15200

3.35%

Dev dependency count

0

-100%

Lines of code

393

8.56%

No dependency changes