docusaurus-plugin-typedoc 0.17.2 → 0.17.3

package/dist/options.js

@@ -1,38 +1,39 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginOptions = void 0;
-const DEFAULT_PLUGIN_OPTIONS = {
-    id: 'default',
-    docsRoot: 'docs',
-    out: 'api',
-    cleanOutputDir: true,
-    sidebar: {
-        fullNames: false,
-        categoryLabel: 'API',
-        indexLabel: undefined,
-        readmeLabel: 'Readme',
-        position: null,
-    },
-    hideInPageTOC: true,
-    hideBreadcrumbs: true,
-    hidePageTitle: true,
-    entryDocument: 'index.md',
-    plugin: ['none'],
-    watch: false,
-    includeExtension: true,
-    indexSlug: undefined,
-    theme: 'docusaurus',
-    frontmatter: undefined,
-};
-const getPluginOptions = (opts) => {
-    const options = {
-        ...DEFAULT_PLUGIN_OPTIONS,
-        ...opts,
-        sidebar: {
-            ...DEFAULT_PLUGIN_OPTIONS.sidebar,
-            ...opts.sidebar,
-        },
-    };
-    return options;
-};
-exports.getPluginOptions = getPluginOptions;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPluginOptions = void 0;
+const DEFAULT_PLUGIN_OPTIONS = {
+    id: 'default',
+    docsRoot: 'docs',
+    out: 'api',
+    cleanOutputDir: true,
+    sidebar: {
+        fullNames: false,
+        categoryLabel: 'API',
+        indexLabel: undefined,
+        readmeLabel: 'Readme',
+        position: null,
+    },
+    hideInPageTOC: true,
+    hideBreadcrumbs: true,
+    hidePageTitle: true,
+    hideMembersSymbol: false,
+    entryDocument: 'index.md',
+    plugin: ['none'],
+    watch: false,
+    includeExtension: true,
+    indexSlug: undefined,
+    theme: 'docusaurus',
+    frontmatter: undefined,
+};
+const getPluginOptions = (opts) => {
+    const options = {
+        ...DEFAULT_PLUGIN_OPTIONS,
+        ...opts,
+        sidebar: {
+            ...DEFAULT_PLUGIN_OPTIONS.sidebar,
+            ...opts.sidebar,
+        },
+    };
+    return options;
+};
+exports.getPluginOptions = getPluginOptions;

package/dist/plugin.d.ts

@@ -1,5 +1,5 @@
-import { PluginOptions } from './types';
-export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
-    name: string;
-    loadContent(): Promise<void>;
-};
+import { PluginOptions } from './types';
+export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
+    name: string;
+    loadContent(): Promise<void>;
+};

package/dist/plugin.js

@@ -1,65 +1,65 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = __importStar(require("path"));
-const typedoc_1 = require("typedoc");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-const options_1 = require("./options");
-const render_1 = require("./render");
-const theme_1 = require("./theme");
-const apps = [];
-function pluginDocusaurus(context, opts) {
-    return {
-        name: 'docusaurus-plugin-typedoc',
-        async loadContent() {
-            if (opts.id && !apps.includes(opts.id)) {
-                apps.push(opts.id);
-                const { siteDir } = context;
-                const options = (0, options_1.getPluginOptions)(opts);
-                const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
-                if (opts.cleanOutputDir) {
-                    (0, render_1.removeDir)(outputDir);
-                }
-                const app = new typedoc_1.Application();
-                app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
-                (0, typedoc_plugin_markdown_1.load)(app);
-                (0, render_1.bootstrap)(app, options);
-                const project = app.convert();
-                if (!project) {
-                    return;
-                }
-                if (options.watch) {
-                    app.convertAndWatch(async (project) => {
-                        await app.generateDocs(project, outputDir);
-                    });
-                }
-                else {
-                    await app.generateDocs(project, outputDir);
-                }
-            }
-        },
-    };
-}
-exports.default = pluginDocusaurus;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
+const options_1 = require("./options");
+const render_1 = require("./render");
+const theme_1 = require("./theme");
+const apps = [];
+function pluginDocusaurus(context, opts) {
+    return {
+        name: 'docusaurus-plugin-typedoc',
+        async loadContent() {
+            if (opts.id && !apps.includes(opts.id)) {
+                apps.push(opts.id);
+                const { siteDir } = context;
+                const options = (0, options_1.getPluginOptions)(opts);
+                const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
+                if (opts.cleanOutputDir) {
+                    (0, render_1.removeDir)(outputDir);
+                }
+                const app = new typedoc_1.Application();
+                app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
+                (0, typedoc_plugin_markdown_1.load)(app);
+                (0, render_1.bootstrap)(app, options);
+                const project = app.convert();
+                if (!project) {
+                    return;
+                }
+                if (options.watch) {
+                    app.convertAndWatch(async (project) => {
+                        await app.generateDocs(project, outputDir);
+                    });
+                }
+                else {
+                    await app.generateDocs(project, outputDir);
+                }
+            }
+        },
+    };
+}
+exports.default = pluginDocusaurus;

package/dist/render.d.ts

@@ -1,5 +1,5 @@
-import { Application, ProjectReflection } from 'typedoc';
-import { PluginOptions } from './types';
-export declare const bootstrap: (app: Application, options: PluginOptions) => void;
-export declare function render(project: ProjectReflection, outputDirectory: string): Promise<void>;
-export declare function removeDir(path: string): void;
+import { Application, ProjectReflection } from 'typedoc';
+import { PluginOptions } from './types';
+export declare const bootstrap: (app: Application, options: PluginOptions) => void;
+export declare function render(project: ProjectReflection, outputDirectory: string): Promise<void>;
+export declare function removeDir(path: string): void;

package/dist/render.js

@@ -1,106 +1,106 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeDir = exports.render = exports.bootstrap = void 0;
-const fs = __importStar(require("fs"));
-const typedoc_1 = require("typedoc");
-const bootstrap = (app, options) => {
-    addTypedocReaders(app);
-    addTypedocDeclarations(app);
-    app.renderer.render = render;
-    app.bootstrap(options);
-};
-exports.bootstrap = bootstrap;
-async function render(project, outputDirectory) {
-    var _a;
-    if (!this.prepareTheme()) {
-        return;
-    }
-    const output = new typedoc_1.RendererEvent(typedoc_1.RendererEvent.BEGIN, outputDirectory, project);
-    output.urls = this.theme.getUrls(project);
-    this.trigger(output);
-    if (!output.isDefaultPrevented) {
-        (_a = output === null || output === void 0 ? void 0 : output.urls) === null || _a === void 0 ? void 0 : _a.forEach((mapping) => {
-            this.renderDocument(output.createPageEvent(mapping));
-        });
-        this.trigger(typedoc_1.RendererEvent.END, output);
-    }
-}
-exports.render = render;
-const addTypedocReaders = (app) => {
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.TSConfigReader());
-};
-const addTypedocDeclarations = (app) => {
-    app.options.addDeclaration({
-        name: 'id',
-    });
-    app.options.addDeclaration({
-        name: 'docsRoot',
-    });
-    app.options.addDeclaration({
-        name: 'siteDir',
-    });
-    app.options.addDeclaration({
-        name: 'globalsTitle',
-    });
-    app.options.addDeclaration({
-        name: 'readmeTitle',
-    });
-    app.options.addDeclaration({
-        name: 'indexSlug',
-    });
-    app.options.addDeclaration({
-        name: 'includeExtension',
-    });
-    app.options.addDeclaration({
-        name: 'sidebar',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-    app.options.addDeclaration({
-        name: 'frontmatter',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-};
-function removeDir(path) {
-    if (fs.existsSync(path)) {
-        const files = fs.readdirSync(path);
-        if (files.length > 0) {
-            files.forEach(function (filename) {
-                if (fs.statSync(path + '/' + filename).isDirectory()) {
-                    removeDir(path + '/' + filename);
-                }
-                else {
-                    fs.unlinkSync(path + '/' + filename);
-                }
-            });
-            fs.rmdirSync(path);
-        }
-        else {
-            fs.rmdirSync(path);
-        }
-    }
-}
-exports.removeDir = removeDir;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeDir = exports.render = exports.bootstrap = void 0;
+const fs = __importStar(require("fs"));
+const typedoc_1 = require("typedoc");
+const bootstrap = (app, options) => {
+    addTypedocReaders(app);
+    addTypedocDeclarations(app);
+    app.renderer.render = render;
+    app.bootstrap(options);
+};
+exports.bootstrap = bootstrap;
+async function render(project, outputDirectory) {
+    var _a;
+    if (!this.prepareTheme()) {
+        return;
+    }
+    const output = new typedoc_1.RendererEvent(typedoc_1.RendererEvent.BEGIN, outputDirectory, project);
+    output.urls = this.theme.getUrls(project);
+    this.trigger(output);
+    if (!output.isDefaultPrevented) {
+        (_a = output === null || output === void 0 ? void 0 : output.urls) === null || _a === void 0 ? void 0 : _a.forEach((mapping) => {
+            this.renderDocument(output.createPageEvent(mapping));
+        });
+        this.trigger(typedoc_1.RendererEvent.END, output);
+    }
+}
+exports.render = render;
+const addTypedocReaders = (app) => {
+    app.options.addReader(new typedoc_1.TypeDocReader());
+    app.options.addReader(new typedoc_1.TSConfigReader());
+};
+const addTypedocDeclarations = (app) => {
+    app.options.addDeclaration({
+        name: 'id',
+    });
+    app.options.addDeclaration({
+        name: 'docsRoot',
+    });
+    app.options.addDeclaration({
+        name: 'siteDir',
+    });
+    app.options.addDeclaration({
+        name: 'globalsTitle',
+    });
+    app.options.addDeclaration({
+        name: 'readmeTitle',
+    });
+    app.options.addDeclaration({
+        name: 'indexSlug',
+    });
+    app.options.addDeclaration({
+        name: 'includeExtension',
+    });
+    app.options.addDeclaration({
+        name: 'sidebar',
+        type: typedoc_1.ParameterType.Mixed,
+    });
+    app.options.addDeclaration({
+        name: 'frontmatter',
+        type: typedoc_1.ParameterType.Mixed,
+    });
+};
+function removeDir(path) {
+    if (fs.existsSync(path)) {
+        const files = fs.readdirSync(path);
+        if (files.length > 0) {
+            files.forEach(function (filename) {
+                if (fs.statSync(path + '/' + filename).isDirectory()) {
+                    removeDir(path + '/' + filename);
+                }
+                else {
+                    fs.unlinkSync(path + '/' + filename);
+                }
+            });
+            fs.rmdirSync(path);
+        }
+        else {
+            fs.rmdirSync(path);
+        }
+    }
+}
+exports.removeDir = removeDir;

package/dist/theme.d.ts

@@ -1,27 +1,27 @@
-import { DeclarationReflection, PageEvent, ReflectionKind, Renderer, RendererEvent } from 'typedoc';
-import { MarkdownTheme } from 'typedoc-plugin-markdown/dist/theme';
-import { FrontMatter, SidebarOptions } from './types';
-export declare class DocusaurusTheme extends MarkdownTheme {
-    sidebar: SidebarOptions;
-    readmeTitle: string;
-    indexSlug: string;
-    includeExtension: string;
-    frontmatter: FrontMatter;
-    constructor(renderer: Renderer);
-    getRelativeUrl(url: string): string;
-    onPageEnd(page: PageEvent<DeclarationReflection>): void;
-    onRendererEnd(renderer: RendererEvent): void;
-    getYamlItems(page: PageEvent<DeclarationReflection>): FrontMatter;
-    getSidebarLabel(page: PageEvent<DeclarationReflection>): string | undefined;
-    getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
-    getId(page: PageEvent): string;
-    getTitle(page: PageEvent): any;
-    getSlug(): string;
-    get mappings(): {
-        kind: ReflectionKind[];
-        isLeaf: boolean;
-        directory: string;
-        template: (pageEvent: PageEvent<import("typedoc").ContainerReflection>) => string;
-    }[];
-    get globalsFile(): string;
-}
+import { DeclarationReflection, PageEvent, ReflectionKind, Renderer, RendererEvent } from 'typedoc';
+import { MarkdownTheme } from 'typedoc-plugin-markdown/dist/theme';
+import { FrontMatter, SidebarOptions } from './types';
+export declare class DocusaurusTheme extends MarkdownTheme {
+    sidebar: SidebarOptions;
+    readmeTitle: string;
+    indexSlug: string;
+    includeExtension: string;
+    frontmatter: FrontMatter;
+    constructor(renderer: Renderer);
+    getRelativeUrl(url: string): string;
+    onPageEnd(page: PageEvent<DeclarationReflection>): void;
+    onRendererEnd(renderer: RendererEvent): void;
+    getYamlItems(page: PageEvent<DeclarationReflection>): FrontMatter;
+    getSidebarLabel(page: PageEvent<DeclarationReflection>): string | undefined;
+    getSidebarPosition(page: PageEvent<DeclarationReflection>): "0.5" | "0" | null;
+    getId(page: PageEvent): string;
+    getTitle(page: PageEvent): any;
+    getSlug(): string;
+    get mappings(): {
+        kind: ReflectionKind[];
+        isLeaf: boolean;
+        directory: string;
+        template: (pageEvent: PageEvent<import("typedoc").ContainerReflection>) => string;
+    }[];
+    get globalsFile(): string;
+}