docusaurus-plugin-typedoc 1.0.0-next.3 → 1.0.0-next.5

package/dist/navigation.d.ts

@@ -1,4 +1,3 @@
-import { ReflectionKind } from 'typedoc';
 export declare const CATEGORY_POSITION: {
     2: number;
     4: number;
@@ -10,4 +9,3 @@ export declare const CATEGORY_POSITION: {
     64: number;
     2097152: number;
 };
-export declare function getKindPlural(kind: ReflectionKind): string;

package/dist/navigation.js

@@ -1,14 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKindPlural = exports.CATEGORY_POSITION = void 0;
+exports.CATEGORY_POSITION = void 0;
 const typedoc_1 = require("typedoc");
-const PLURALS = {
-    [typedoc_1.ReflectionKind.Class]: 'Classes',
-    [typedoc_1.ReflectionKind.Property]: 'Properties',
-    [typedoc_1.ReflectionKind.Enum]: 'Enumerations',
-    [typedoc_1.ReflectionKind.EnumMember]: 'Enumeration members',
-    [typedoc_1.ReflectionKind.TypeAlias]: 'Type aliases',
-};
 exports.CATEGORY_POSITION = {
     [typedoc_1.ReflectionKind.Module]: 1,
     [typedoc_1.ReflectionKind.Namespace]: 1,
@@ -20,17 +13,3 @@ exports.CATEGORY_POSITION = {
     [typedoc_1.ReflectionKind.Function]: 7,
     [typedoc_1.ReflectionKind.ObjectLiteral]: 8,
 };
-function getKindPlural(kind) {
-    if (kind in PLURALS) {
-        return PLURALS[kind];
-    }
-    else {
-        return getKindString(kind) + 's';
-    }
-}
-exports.getKindPlural = getKindPlural;
-function getKindString(kind) {
-    let str = typedoc_1.ReflectionKind[kind];
-    str = str.replace(/(.)([A-Z])/g, (_m, a, b) => a + ' ' + b.toLowerCase());
-    return str;
-}

package/dist/theme.d.ts

@@ -3,11 +3,9 @@ import { MarkdownTheme } from 'typedoc-plugin-markdown';
 import { SidebarOptions } from './types';
 export declare class DocusaurusTheme extends MarkdownTheme {
     sidebar: SidebarOptions;
-    private _contextCache?;
     constructor(renderer: Renderer);
-    getRenderContext(): any;
     onPageEnd(page: PageEvent<DeclarationReflection>): void;
     onRendererEnd(renderer: RendererEvent): void;
-    loopAndWriteCategories(path: string): void;
-    writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean) => void;
+    loopAndWriteCategories(path: string, level?: number): void;
+    writeCategoryYaml: (categoryPath: string, label: string, position: number | null, collapsed: boolean, generatedIndex: boolean) => void;
 }

package/dist/theme.js

@@ -34,11 +34,10 @@ const fs = __importStar(require("fs"));
 const typedoc_1 = require("typedoc");
 const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
 const navigation_1 = require("./navigation");
-const theme_context_1 = require("./theme-context");
 class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
     constructor(renderer) {
         super(renderer);
-        this.writeCategoryYaml = (categoryPath, label, position, collapsed) => {
+        this.writeCategoryYaml = (categoryPath, label, position, collapsed, generatedIndex) => {
             const yaml = [`label: "${label}"`];
             if (position !== null) {
                 yaml.push(`position: ${position}`);
@@ -46,6 +45,11 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
             if (!collapsed) {
                 yaml.push(`collapsed: false`);
             }
+            if (generatedIndex) {
+                yaml.push(`link:
+  type: "generated-index"
+  title: "${label}"`);
+            }
             if (fs.existsSync(categoryPath)) {
                 fs.writeFileSync(categoryPath + '/_category_.yml', yaml.join('\n'));
             }
@@ -55,10 +59,6 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
             [typedoc_1.RendererEvent.END]: this.onRendererEnd,
         });
     }
-    getRenderContext() {
-        this._contextCache || (this._contextCache = new theme_context_1.DocusaurusThemeRenderContext(this, this.application.options));
-        return this._contextCache;
-    }
     onPageEnd(page) {
         if (page.contents) {
             page.contents = page.contents.replace(/\\</g, '<');
@@ -66,11 +66,16 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
     }
     onRendererEnd(renderer) {
         if (this.sidebar.autoConfiguration) {
-            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
+            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed, false);
             this.loopAndWriteCategories(renderer.outputDirectory);
+            const globalsFile = this.getRenderContext().globalsFile;
+            const globalsPath = `${renderer.outputDirectory}/${this.getRenderContext().globalsFile}`;
+            if (fs.existsSync(globalsPath)) {
+                fs.renameSync(globalsPath, `${renderer.outputDirectory}/01-${globalsFile}`);
+            }
         }
     }
-    loopAndWriteCategories(path) {
+    loopAndWriteCategories(path, level = 0) {
         const directory = fs.readdirSync(path);
         directory.forEach((segment) => {
             const fullPath = `${path}/${segment}`;
@@ -83,8 +88,9 @@ class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
                     .map((entry) => entry[1])[0];
                 const subdirectory = fs.readdirSync(fullPath);
                 const containsDir = subdirectory.some((item) => fs.lstatSync(`${fullPath}/${item}`).isDirectory());
-                if (mapping && !containsDir) {
-                    this.writeCategoryYaml(fullPath, (0, navigation_1.getKindPlural)(mapping.kind), navigation_1.CATEGORY_POSITION[mapping.kind], true);
+                if ((mapping && !containsDir) ||
+                    (mapping === null || mapping === void 0 ? void 0 : mapping.kind) === typedoc_1.ReflectionKind.Namespace) {
+                    this.writeCategoryYaml(fullPath, typedoc_1.ReflectionKind.pluralString(mapping.kind), navigation_1.CATEGORY_POSITION[mapping.kind], true, true);
                 }
                 this.loopAndWriteCategories(fullPath);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.3",
+  "version": "1.0.0-next.5",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -16,8 +16,7 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
-    "typedoc": ">=0.23.0",
-    "typedoc-plugin-markdown": ">=4.0.0-next.4"
+    "typedoc-plugin-markdown": ">=4.0.0-next.6"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",

package/dist/theme-context.d.ts

@@ -1,11 +0,0 @@
-import { DeclarationReflection, PageEvent, Reflection } from 'typedoc';
-import { MarkdownThemeRenderContext } from 'typedoc-plugin-markdown';
-export declare class DocusaurusThemeRenderContext extends MarkdownThemeRenderContext {
-    baseFrontmatterVars: (page: PageEvent<Reflection>) => {
-        sidebar_position?: number | undefined;
-        sidebar_label?: string | undefined;
-        title: string;
-    };
-    getSidebarLabel(page: PageEvent<DeclarationReflection>): string | null | undefined;
-    getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
-}

package/dist/theme-context.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocusaurusThemeRenderContext = void 0;
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-class DocusaurusThemeRenderContext extends typedoc_plugin_markdown_1.MarkdownThemeRenderContext {
-    constructor() {
-        super(...arguments);
-        this.baseFrontmatterVars = (page) => {
-            const sidebarPosition = parseFloat(this.getSidebarPosition(page));
-            const sidebarLabel = this.getSidebarLabel(page);
-            return {
-                ...this.getBaseFrontmatterVars(page),
-                ...(this.options.getValue('sidebar').autoConfiguration
-                    ? {
-                        ...(sidebarLabel && { sidebar_label: sidebarLabel }),
-                        ...(sidebarPosition && {
-                            sidebar_position: sidebarPosition,
-                        }),
-                    }
-                    : {}),
-            };
-        };
-    }
-    getSidebarLabel(page) {
-        if (page.url === this.options.getValue('entryDocument')) {
-            return this.options.getValue('sidebar').indexLabel;
-        }
-        return null;
-    }
-    getSidebarPosition(page) {
-        if (page.url === this.options.getValue('entryDocument')) {
-            return page.url === page.project.url ? '0.5' : '0';
-        }
-        if (page.url === this.globalsFile) {
-            return '0.5';
-        }
-        if (page.model.getFullName().split('.').length === 1) {
-            return '0';
-        }
-        return null;
-    }
-}
-exports.DocusaurusThemeRenderContext = DocusaurusThemeRenderContext;