docusaurus-plugin-typedoc 1.0.0-next.7 → 1.0.0-next.9

package/README.md

@@ -1,20 +1,24 @@
 # docusaurus-plugin-typedoc
 
-A [Docusaurus v2](https://v2.docusaurus.io/) plugin to build documentation with [TypeDoc](https://github.com/TypeStrong/typedoc).
+A [Docusaurus](https://v2.docusaurus.io/) plugin to build TypeScript API documentation with [TypeDoc](https://github.com/TypeStrong/typedoc).
 
 [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg)](https://www.npmjs.com/package/docusaurus-plugin-typedoc)
 ![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)
 
-## What it does?
+## What does it do?
 
-Generates static TypeDoc pages in Markdown with frontmatter as part of the Docusaurus build.
+- Presets relevant options of [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown#readme).
+- Runs TypeDoc from the Docusaurus CLI.
+- Adds some basic frontmatter to pages and exposes the ability to configure frontmatter further.
 
 ## Installation
 
 > Install [Docusaurus](https://v2.docusaurus.io/docs/installation) in the root of your project and install the plugin dependencies in the same location as the Docusaurus website directory.
 
+> [typedoc](https://github.com/TypeStrong/typedoc), [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown) and [typedoc-plugin-frontmatter]() are required peer dependencies.
+
 ```shell
-npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
+npm install docusaurus-plugin-typedoc typedoc typedoc-plugin-markdown@next typedoc-plugin-frontmatter@next --save-dev
 ```
 
 ## Usage
@@ -65,42 +69,63 @@ Once built the docs will be available at `/docs/api` (or equivalent out director
 
 ## Options
 
+Options can be declared:
+
+- Passing arguments via the command line.
+- Using a `typedoc.json` file.
+- Under the `typedocOptions` key in `tsconfig.json`.
+
+Please see https://typedoc.org/options/configuration for general TypeDoc option configuration.
+
 ### TypeDoc options
 
-To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/guides/options/) to the config.
+The following TypeDoc / Markdown plugin options can be passed to config:
 
-At a minimum the `entryPoints` and `tsconfig` options will need to be set.
+- [typedoc](https://typedoc.org/options) options (HTML specific output options that will be ignored).
+- [typedoc-plugin-markdown ](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/next/packages/typedoc-plugin-markdown#options) options (Some options are already preset to target Docusaurus).
 
-```js
-entryPoints: ['../src/index.ts'],
-tsconfig: '../tsconfig.json'
+The following typedoc-plugin-markdown options are preset with the plugin.
+
+```json
+{
+  "out": "api",
+  "hideInPageTOC": true,
+  "hideBreadcrumbs": true,
+  "hidePageHeader": true,
+  "entryDocument": "index.md",
+  "includeFileNumberPrefixes": true
+}
 ```
 
-Additional TypeDoc plugins will need to be explicitly set:
+### Plugin options
 
-```js
-plugin: ['typedoc-plugin-xyz'];
-```
+Options specific to the plugin should also be declared in the same object.
 
-#### Other config options
+#### `--sidebar`
 
-TypeDoc options can also be declared:
+`sidebar.autoConfiguration`
 
-- Using a `typedoc.json` file.
-- Under the `typedocOptions` key in `tsconfig.json`.
+Set to `false` to disable sidebar generation. Defaults to `true`.
 
-> Note: Options declared in this manner will take priority and overwrite options declared in `docusaurus.config.js`.
+`sidebar.categoryLabel`
 
-### Plugin options
+The sidebar main parent category label. Defaults to `API`.
 
-Options specific to the plugin should also be declared in the same object.
+`sidebar.indexLabel`
+
+The label of the main index page. Please note if `readme=none` this option has no effect because the index page becomes the root page. Defaults to `Index`.
+
+`sidebar.position`
+
+The position of the sidebar in the tree.
+
+#### `--docsRoot`
+
+The Docusaurus docs folder root. Use `./` if no root folder specified. Defaults to `./docs`.
 
-| Name                    | Default | Description                                              |
-| :---------------------- | :------ | :------------------------------------------------------- |
-| `out`                   | `"api"` | Output dir relative to docs dir (use `.` for no subdir). |
-| `sidebar.categoryLabel` | `API`   | The sidebar parent category label.                       |
-| `sidebar.fullNames`     | `false` | Display full names with module path.                     |
-| `sidebar.position`      | `auto`  | The position of the sidebar in the tree.                 |
+```shell
+--docsRoot <path/to/vitepress-docs/>
+```
 
 ### An example configuration
 
@@ -128,6 +153,21 @@ module.exports = {
 };
 ```
 
+## Frontmatter
+
+Additional frontmatter options can be added to the config. Please see [typedoc-plugin-frontmatter](https://github.com/tgreyuk/typedoc-plugin-frontmatter#typedoc-plugin-frontmatter).
+
+For example:
+
+```json
+{
+  "frontmatterGlobals": {
+    "pagination_prev": null,
+    "pagination_next": null
+  }
+}
+```
+
 ## Recipes
 
 ### Sidebar and Navbar
@@ -190,27 +230,6 @@ A navbar item can be configured in `themeConfig` options in `docusaurus.config.j
 
 Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for navbar documentation.
 
-### Frontmatter
-
-By default the plugin will configure minimal required [Frontmatter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter) configuration.
-Additionally required global Frontmatter options can be passed in using the `frontmatterGlobals` options object
-
-`docusaurus.config.js`:
-
-```js
-plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-      // .... other plugin option
-      frontmatterGlobals: {
-        pagination_prev: null,
-        pagination_next: null
-      }
-    ]
-]
-```
-
 ### Multi instance
 
 It is possible to build multi TypeDoc instances by passing in multiple configs with unique ids:
@@ -272,27 +291,6 @@ module.exports = {
 };
 ```
 
-### Monorepo setup
-
-`docusaurus.config.js`
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        entryPoints: ['../packages/package-a', '../packages/package-b'],
-        entryPointStrategy: 'packages',
-        sidebar: {
-          fullNames: true,
-        },
-      },
-    ],
-  ],
-};
-```
-
 ## License
 
 [MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/docusaurus-plugin-typedoc/LICENSE)

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,8 +1,81 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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.default = void 0;
-var plugin_1 = require("./plugin");
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(plugin_1).default; } });
+const path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const options_1 = require("./options");
+const renderer_1 = require("./renderer");
+const apps = [];
+function pluginDocusaurus(context, opts) {
+    return {
+        name: 'docusaurus-plugin-typedoc',
+        async loadContent() {
+            if (opts.id && !apps.includes(opts.id)) {
+                apps.push(opts.id);
+                generateTypedoc(context, opts);
+            }
+        },
+        extendCli(cli) {
+            cli
+                .command('generate-typedoc')
+                .description('(docusaurus-plugin-typedoc) Generate TypeDoc docs independently of the Docusaurus build process.')
+                .action(async () => {
+                var _a;
+                (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.plugins.forEach((pluginConfig) => {
+                    if (pluginConfig && typeof pluginConfig[1] === 'object') {
+                        generateTypedoc(context, pluginConfig[1]);
+                    }
+                });
+            });
+        },
+    };
+}
+exports.default = pluginDocusaurus;
+async function generateTypedoc(context, opts) {
+    const { siteDir } = context;
+    const options = (0, options_1.getPluginOptions)(opts);
+    const { id, docsRoot, ...optionsPassedToTypeDoc } = options;
+    const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
+    const app = new typedoc_1.Application();
+    (0, options_1.loadOptions)(app);
+    (0, renderer_1.loadRenderer)(app);
+    await app.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    const project = app.convert();
+    if (!project) {
+        if (app.options.getValue('skipErrorChecking')) {
+            return;
+        }
+        console.error('[docusaurus-plugin-typedoc] TypeDoc exited with an error. Use the "skipErrorChecking" option to disable TypeDoc error checking.');
+        process.exit();
+    }
+    if (options.watch) {
+        app.convertAndWatch(async (project) => {
+            await app.generateDocs(project, outputDir);
+        });
+    }
+    else {
+        await app.generateDocs(project, outputDir);
+    }
+}

package/dist/models.d.ts

@@ -6,13 +6,19 @@ export interface PluginOptions extends TypedocPluginMarkdownOptions {
 }
 export interface SidebarOptions {
     categoryLabel: string;
-    collapsed: boolean;
     position: number | null;
     autoConfiguration: boolean;
+    indexLabel: string;
 }
 export interface SidebarCategory {
     type: string;
     label: string;
     items: SidebarItem[];
 }
+export interface CategoryYamlOptions {
+    path: string;
+    label: string;
+    position: number | null;
+    collapsed: boolean;
+}
 export type SidebarItem = SidebarCategory | string;

package/dist/options.d.ts

@@ -1,2 +1,4 @@
+import { Application } from 'typedoc';
 import { PluginOptions } from './models';
-export declare const getPluginOptions: (opts: Partial<PluginOptions>) => PluginOptions;
+export declare function getPluginOptions(opts: Partial<PluginOptions>): PluginOptions;
+export declare function loadOptions(app: Application): void;

package/dist/options.js

@@ -1,26 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginOptions = void 0;
+exports.loadOptions = exports.getPluginOptions = void 0;
+const typedoc_1 = require("typedoc");
 const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
     docsRoot: 'docs',
     out: 'api',
+    watch: false,
+    plugin: [],
+    hideInPageTOC: true,
+    hideBreadcrumbs: true,
+    hidePageHeader: true,
+    includeFileNumberPrefixes: true,
     sidebar: {
         categoryLabel: 'API',
-        collapsed: true,
         position: null,
         autoConfiguration: true,
+        indexLabel: 'Index',
     },
-    hideInPageTOC: true,
-    hideBreadcrumbs: true,
-    hidePageTitle: false,
-    entryDocument: 'index.md',
-    watch: false,
-    enableFrontmatter: true,
-    numberPrefixOutput: true,
-    theme: 'docusaurus',
 };
-const getPluginOptions = (opts) => {
+function getPluginOptions(opts) {
     const options = {
         ...DEFAULT_PLUGIN_OPTIONS,
         ...opts,
@@ -30,5 +29,31 @@ const getPluginOptions = (opts) => {
         },
     };
     return options;
-};
+}
 exports.getPluginOptions = getPluginOptions;
+function loadOptions(app) {
+    app.options.addReader(new typedoc_1.PackageJsonReader());
+    app.options.addReader(new typedoc_1.TypeDocReader());
+    app.options.addReader(new typedoc_1.TSConfigReader());
+    app.options.addDeclaration({
+        name: 'sidebar',
+        type: typedoc_1.ParameterType.Mixed,
+    });
+    app.options.addReader(new (class {
+        constructor() {
+            this.name = 'docusaurus-options';
+            this.order = 900;
+            this.supportsPackages = false;
+        }
+        read(container) {
+            const plugins = container.getValue('plugin');
+            ['typedoc-plugin-markdown', 'typedoc-plugin-frontmatter'].forEach((defaultPlugin) => {
+                if (!plugins.includes(defaultPlugin)) {
+                    plugins.push(defaultPlugin);
+                }
+            });
+            container.setValue('plugin', plugins);
+        }
+    })());
+}
+exports.loadOptions = loadOptions;

package/dist/renderer.d.ts

@@ -0,0 +1,2 @@
+import { Application } from 'typedoc';
+export declare function loadRenderer(app: Application): void;

package/dist/renderer.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadRenderer = void 0;
+const typedoc_1 = require("typedoc");
+const typedoc_plugin_frontmatter_1 = require("typedoc-plugin-frontmatter");
+function loadRenderer(app) {
+    app.renderer.on(typedoc_1.PageEvent.END, (page) => {
+        if (page.contents) {
+            page.contents = page.contents.replace(/\\</g, '<');
+        }
+    });
+    app.renderer.on(typedoc_plugin_frontmatter_1.FrontmatterEvent.PREPARE_FRONTMATTER, (event) => {
+        loadFrontmatter(app, event);
+    });
+}
+exports.loadRenderer = loadRenderer;
+function loadFrontmatter(app, event) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const renderContext = app.renderer.theme.getRenderContext();
+    const hasReadme = !app.options.getValue('readme').endsWith('none');
+    const sidebar = app.options.getValue('sidebar');
+    const isModulesPage = (_a = event.page) === null || _a === void 0 ? void 0 : _a.url.endsWith(renderContext.modulesFile);
+    const isIndexPage = (_b = event.page) === null || _b === void 0 ? void 0 : _b.url.endsWith(renderContext.indexFile);
+    const isReadmePage = (_c = event.page) === null || _c === void 0 ? void 0 : _c.url.endsWith(renderContext.readmeFile);
+    const isPackageModule = event.page.model.kindOf(typedoc_1.ReflectionKind.Module) &&
+        !Boolean(((_d = event.page.model) === null || _d === void 0 ? void 0 : _d.parent).groups);
+    const model = (_e = event.page) === null || _e === void 0 ? void 0 : _e.model;
+    let pluginFrontmatter = {};
+    if (sidebar.autoConfiguration) {
+        if (!isModulesPage && !isReadmePage) {
+            const sidebarLabel = !model.kindOf(typedoc_1.ReflectionKind.Module) &&
+                !app.options.getValue('hideKindTag') &&
+                app.options.getValue('excludeGroups')
+                ? `(${Array.from(typedoc_1.ReflectionKind.singularString(model.kind))[0]}) ${model === null || model === void 0 ? void 0 : model.name}`
+                : model === null || model === void 0 ? void 0 : model.name;
+            pluginFrontmatter = {
+                ...pluginFrontmatter,
+                sidebar_label: sidebarLabel,
+            };
+        }
+        if (((_f = event.page) === null || _f === void 0 ? void 0 : _f.url) === renderContext.readmeFile ||
+            (!hasReadme && isModulesPage)) {
+            if (sidebar.categoryLabel) {
+                pluginFrontmatter = {
+                    ...pluginFrontmatter,
+                    sidebar_label: sidebar.categoryLabel,
+                };
+            }
+            if (sidebar.position !== null && !Number.isNaN(sidebar.position)) {
+                pluginFrontmatter = {
+                    ...pluginFrontmatter,
+                    sidebar_position: sidebar.position,
+                };
+            }
+        }
+        if (isModulesPage) {
+            pluginFrontmatter = {
+                ...pluginFrontmatter,
+                sidebar_label: sidebar.indexLabel,
+            };
+        }
+        if (isPackageModule && isReadmePage) {
+            pluginFrontmatter = {
+                ...pluginFrontmatter,
+                sidebar_label: event.page.model.name,
+            };
+        }
+        if (isPackageModule && isIndexPage && Boolean((_g = event.page.model) === null || _g === void 0 ? void 0 : _g.readme)) {
+            pluginFrontmatter = {
+                ...pluginFrontmatter,
+                sidebar_label: sidebar.indexLabel,
+            };
+        }
+        if (isPackageModule && isIndexPage && !Boolean((_h = event.page.model) === null || _h === void 0 ? void 0 : _h.readme)) {
+            pluginFrontmatter = {
+                ...pluginFrontmatter,
+                sidebar_label: event.page.model.name,
+            };
+        }
+    }
+    event.frontmatter = {
+        ...pluginFrontmatter,
+        ...event.frontmatter,
+    };
+}

package/package.json

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

package/dist/plugin.d.ts

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

package/dist/plugin.js

@@ -1,80 +0,0 @@
-"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);
-                generateTypedoc(context, opts);
-            }
-        },
-        extendCli(cli) {
-            cli
-                .command('generate-typedoc')
-                .description('(docusaurus-plugin-typedoc) Generate TypeDoc docs independently of the Docusaurus build process.')
-                .action(async () => {
-                var _a;
-                (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.plugins.forEach((pluginConfig) => {
-                    if (pluginConfig && typeof pluginConfig[1] === 'object') {
-                        generateTypedoc(context, pluginConfig[1]);
-                    }
-                });
-            });
-        },
-    };
-}
-exports.default = pluginDocusaurus;
-async function generateTypedoc(context, opts) {
-    const { siteDir } = context;
-    const options = (0, options_1.getPluginOptions)(opts);
-    const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
-    const app = new typedoc_1.Application();
-    app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
-    (0, typedoc_plugin_markdown_1.load)(app);
-    (0, render_1.addTypedocReaders)(app);
-    (0, render_1.addTypedocDeclarations)(app);
-    await app.bootstrapWithPlugins(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);
-    }
-}

package/dist/render.d.ts

@@ -1,3 +0,0 @@
-import { Application } from 'typedoc';
-export declare function addTypedocReaders(app: Application): void;
-export declare function addTypedocDeclarations(app: Application): void;

package/dist/render.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addTypedocDeclarations = exports.addTypedocReaders = void 0;
-const typedoc_1 = require("typedoc");
-function addTypedocReaders(app) {
-    app.options.addReader(new typedoc_1.TypeDocReader());
-    app.options.addReader(new typedoc_1.TSConfigReader());
-}
-exports.addTypedocReaders = addTypedocReaders;
-function addTypedocDeclarations(app) {
-    app.options.addDeclaration({
-        name: 'id',
-    });
-    app.options.addDeclaration({
-        name: 'docsRoot',
-    });
-    app.options.addDeclaration({
-        name: 'globalsTitle',
-    });
-    app.options.addDeclaration({
-        name: 'sidebar',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-}
-exports.addTypedocDeclarations = addTypedocDeclarations;

package/dist/theme.d.ts

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

package/dist/theme.js

@@ -1,95 +0,0 @@
-"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 __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-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.DocusaurusTheme = void 0;
-const fs = __importStar(require("fs"));
-const typedoc_1 = require("typedoc");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-class DocusaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
-    constructor(renderer) {
-        super(renderer);
-        this.writeCategoryYaml = (categoryPath, label, position, collapsed, generatedIndex) => {
-            const yaml = [`label: "${label}"`];
-            if (position !== null) {
-                yaml.push(`position: ${position}`);
-            }
-            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'));
-            }
-        };
-        this.listenTo(this.application.renderer, {
-            [typedoc_1.PageEvent.END]: this.onPageEnd,
-            [typedoc_1.RendererEvent.END]: this.onRendererEnd,
-        });
-    }
-    onPageEnd(page) {
-        if (page.contents) {
-            page.contents = page.contents.replace(/\\</g, '<');
-        }
-    }
-    onRendererEnd(renderer) {
-        if (this.sidebar.autoConfiguration) {
-            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed, false);
-            this.loopAndWriteCategories(renderer.outputDirectory);
-        }
-    }
-    loopAndWriteCategories(path, level = 0) {
-        const directory = fs.readdirSync(path);
-        directory.forEach((segment) => {
-            const fullPath = `${path}/${segment}`;
-            const isDirectory = fs.lstatSync(fullPath).isDirectory();
-            if (isDirectory) {
-                const mapping = Object.entries(this.mappings)
-                    .filter((entry) => {
-                    return entry[1].directory === segment.slice(3);
-                })
-                    .map((entry) => entry[1])[0];
-                const subdirectory = fs.readdirSync(fullPath);
-                if (mapping && !subdirectory.includes(`${mapping === null || mapping === void 0 ? void 0 : mapping.directory}.md`)) {
-                    this.writeCategoryYaml(fullPath, typedoc_1.ReflectionKind.pluralString(mapping.kind), null, true, true);
-                }
-                this.loopAndWriteCategories(fullPath);
-            }
-        });
-    }
-}
-__decorate([
-    (0, typedoc_1.BindOption)('sidebar')
-], DocusaurusTheme.prototype, "sidebar", void 0);
-exports.DocusaurusTheme = DocusaurusTheme;