docusaurus-plugin-typedoc 0.17.4 → 0.17.5

package/dist/options.js

@@ -12,6 +12,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
         indexLabel: undefined,
         readmeLabel: 'Readme',
         position: null,
+        autoConfiguration: true,
     },
     hideInPageTOC: true,
     hideBreadcrumbs: true,

package/dist/theme.d.ts

@@ -16,7 +16,6 @@ export declare class DocusaurusTheme extends MarkdownTheme {
     getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
     getId(page: PageEvent): string;
     getTitle(page: PageEvent): any;
-    getSlug(): string;
     get mappings(): {
         kind: ReflectionKind[];
         isLeaf: boolean;

package/dist/theme.js

@@ -30,11 +30,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocusaurusTheme = void 0;
-const typedoc_1 = require("typedoc");
 const fs = __importStar(require("fs"));
-const theme_1 = require("typedoc-plugin-markdown/dist/theme");
-const groups_1 = require("typedoc-plugin-markdown/dist/groups");
 const path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const groups_1 = require("typedoc-plugin-markdown/dist/groups");
+const theme_1 = require("typedoc-plugin-markdown/dist/theme");
 const front_matter_1 = require("typedoc-plugin-markdown/dist/utils/front-matter");
 const CATEGORY_POSITION = {
     [typedoc_1.ReflectionKind.Module]: 1,
@@ -69,14 +69,16 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
         }
     }
     onRendererEnd(renderer) {
-        writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position);
-        Object.keys(groupUrlsByKind(this.getUrls(renderer.project))).forEach((group) => {
-            const kind = parseInt(group);
-            const mapping = this.mappings.find((mapping) => mapping.kind.includes(kind));
-            if (mapping) {
-                writeCategoryYaml(renderer.outputDirectory + '/' + mapping.directory, (0, groups_1.getKindPlural)(kind), CATEGORY_POSITION[kind]);
-            }
-        });
+        if (this.sidebar.autoConfiguration) {
+            writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position);
+            Object.keys(groupUrlsByKind(this.getUrls(renderer.project))).forEach((group) => {
+                const kind = parseInt(group);
+                const mapping = this.mappings.find((mapping) => mapping.kind.includes(kind));
+                if (mapping) {
+                    writeCategoryYaml(renderer.outputDirectory + '/' + mapping.directory, (0, groups_1.getKindPlural)(kind), CATEGORY_POSITION[kind]);
+                }
+            });
+        }
     }
     getYamlItems(page) {
         const pageId = this.getId(page);
@@ -87,14 +89,16 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
             id: pageId,
             title: pageTitle,
         };
-        if (page.url === this.entryDocument) {
-            items = { ...items, slug: this.getSlug() };
+        if (page.url === this.entryDocument && this.indexSlug) {
+            items = { ...items, slug: this.indexSlug };
         }
-        if (sidebarLabel && sidebarLabel !== pageTitle) {
-            items = { ...items, sidebar_label: sidebarLabel };
-        }
-        if (sidebarPosition) {
-            items = { ...items, sidebar_position: parseFloat(sidebarPosition) };
+        if (this.sidebar.autoConfiguration) {
+            if (sidebarLabel && sidebarLabel !== pageTitle) {
+                items = { ...items, sidebar_label: sidebarLabel };
+            }
+            if (sidebarPosition) {
+                items = { ...items, sidebar_position: parseFloat(sidebarPosition) };
+            }
         }
         if (page.url === page.project.url && this.entryPoints.length > 1) {
             items = { ...items, hide_table_of_contents: true };
@@ -142,15 +146,6 @@ class DocusaurusTheme extends theme_1.MarkdownTheme {
         }
         return (0, front_matter_1.getPageTitle)(page);
     }
-    getSlug() {
-        if (this.indexSlug) {
-            return this.indexSlug;
-        }
-        if (this.out === process.cwd()) {
-            return '/';
-        }
-        return `/${path.relative(process.cwd(), this.out).replace(/\\/g, '/')}/`;
-    }
     get mappings() {
         return super.mappings.map((mapping) => {
             if (mapping.kind.includes(typedoc_1.ReflectionKind.Namespace)) {

package/dist/types.d.ts

@@ -28,6 +28,7 @@ export interface SidebarOptions {
     indexLabel?: string;
     readmeLabel?: string;
     position: number | null;
+    autoConfiguration: boolean;
 }
 export interface SidebarCategory {
     type: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "0.17.4",
+  "version": "0.17.5",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -39,5 +39,5 @@
     "typescript",
     "api"
   ],
-  "gitHead": "57c7498a9c3d2a82e803ed98f905258b25f4f4eb"
+  "gitHead": "e4e2f96384fdc3d93b172c4ce64df56ba66f1528"
 }