typedoc-github-wiki-theme - npm Package Compare versions

Comparing version 0.4.3 to 0.5.0

dist/options.d.ts

 declare const _default: {
     entryDocument: string;
     hideBreadcrumbs: boolean;
-    hidePageTitle: boolean;
 };
 export default _default;

dist/options.js

@@ -6,3 +6,2 @@ "use strict";
     hideBreadcrumbs: true,
-    hidePageTitle: true,
 };

dist/theme.d.ts

@@ -1,2 +0,2 @@
-import { DeclarationReflection, Reflection } from 'typedoc';
+import { DeclarationReflection } from 'typedoc';
 import MarkdownTheme from 'typedoc-plugin-markdown/dist/theme';
@@ -12,7 +12,6 @@ import { RendererEvent } from 'typedoc/dist/lib/output/events';
     toUrl(mapping: TemplateMapping, reflection: DeclarationReflection): string;
-    getUrl(reflection: Reflection): string;
     isOutputDirectory(outputDirectory: string): boolean;
     allowedDirectoryListings(): string[];
-    onRendererEnd(renderer: RendererEvent): void;
+    writeSidebar(renderer: RendererEvent): void;
     get globalsFile(): "Modules.md" | "Exports.md";
 }

dist/theme.js

@@ -12,3 +12,2 @@ "use strict";
 const theme_1 = require("typedoc-plugin-markdown/dist/theme");
-const plugins_1 = require("typedoc/dist/lib/converter/plugins");
 const events_1 = require("typedoc/dist/lib/output/events");
@@ -20,11 +19,7 @@ const utils_1 = require("./components/utils");
         renderer.addComponent('utils', new utils_1.UtilsComponent(renderer));
-        this.listenTo(renderer, events_1.RendererEvent.END, this.onRendererEnd, 1024);
+        this.listenTo(renderer, events_1.RendererEvent.END, this.writeSidebar, 1024);
     }
     toUrl(mapping, reflection) {
-        return `${plugins_1.GroupPlugin.getKindSingular(reflection.kind)}-${this.getUrl(reflection)}.md`;
+        return `${reflection.getFullName()}.md`;
     }
-    getUrl(reflection) {
-        const url = reflection.name;
-        return url;
-    }
     isOutputDirectory(outputDirectory) {
@@ -51,3 +46,3 @@ let isOutputDirectory = true;
     }
-    onRendererEnd(renderer) {
+    writeSidebar(renderer) {
         var _a;
@@ -57,3 +52,4 @@ const parseUrl = (url) => '../wiki/' + url.replace('.md', '');
         const navJson = [`## ${renderer.project.name}\n`];
-        (_a = navigation.children) === null || _a === void 0 ? void 0 : _a.forEach((navItem) => {
+        const allowedSections = ['Home', 'Modules', 'Namespaces'];
+        (_a = navigation.children) === null || _a === void 0 ? void 0 : _a.filter((navItem) => !navItem.isLabel || allowedSections.includes(navItem.title)).forEach((navItem) => {
             var _a;
@@ -60,0 +56,0 @@ if (navItem.isLabel) {

package.json

 {
   "name": "typedoc-github-wiki-theme",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for Github Wiki pages.",
@@ -36,3 +36,3 @@ "main": "dist/theme.js",
   ],
-  "gitHead": "14b92b4c0ac52575cea145f9e028c1b8de64b094"
+  "gitHead": "19240ec4ecc93dbc6052ceefbafd8f8a94c1cecf"
 }

No alert changes

Worsened metrics

Total package byte prevSize

9470

decreased by-1.8%

Lines of code

131

decreased by-5.07%

No dependency changes