docusaurus-plugin-typedoc 1.0.0-next.2 → 1.0.0-next.20

package/README.md

@@ -1,26 +1,36 @@
 # docusaurus-plugin-typedoc
 
-A [Docusaurus v2](https://v2.docusaurus.io/) plugin to build documentation with [TypeDoc](https://github.com/TypeStrong/typedoc).
+![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
 
-[![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)
+A [Docusaurus](https://v2.docusaurus.io/) plugin to build TypeScript API documentation with [TypeDoc](https://github.com/TypeStrong/typedoc).
 
-## What it does?
+## Contents
 
-Generates static TypeDoc pages in Markdown with frontmatter as part of the Docusaurus build.
+- [What does it do?](#what-does-it-do)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Options](#options)
+- [Sidebar](#sidebar)
+- [Other configuration](#other-configuration)
+- [License](#license)
+
+## What does it do?
+
+- 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.
 
 ## 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) and [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown) are peer dependencies.
+
 ```shell
-npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
+npm install docusaurus-plugin-typedoc typedoc typedoc-plugin-markdown@next --save-dev
 ```
 
 ## Usage
 
-### Config
-
 Add the plugin to `docusaurus.config.js` and specify the required options (see [options](#options)).
 
 ```js
@@ -46,130 +56,119 @@ TypeDoc will be bootstraped with the Docusaurus `start` and `build` [cli command
 "build": "docusaurus build",
 ```
 
-Once built the docs will be available at `/docs/api` (or equivalent out directory).
+Once built the docs will be available at `http://localhost:3000/docs/api` (or equivalent out directory).
 
-### Directory structure
+Typical directory structure:
 
-```
-├── docusauruss-website
-    ├── build/ (static site dir)
-    ├── docs/
-    │   ├── api/ (compiled typedoc markdown)
-    ├── docusaurus.config.js
-    ├── package.json
-    ├── sidebars.js
-├──package.json
-├──src (typescript source files)
-├──tsconfig.json
-```
+        ├── docusaurus-website
+            ├── build/ (static site dir)
+            ├── docs/
+            │   ├── api/ (compiled typedoc markdown)
+            ├── docusaurus.config.js
+            ├── package.json
+            ├── sidebars.js
+        ├──package.json
+        ├──src (typescript source files)
+        ├──tsconfig.json
 
 ## Options
 
 ### TypeDoc options
 
-To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/guides/options/) to the config.
+Options can be declared:
 
-At a minimum the `entryPoints` and `tsconfig` options will need to be set.
+- Passing arguments via the command line.
+- Using a `typedoc.json` file.
+- Under the `typedocOptions` key in `tsconfig.json`.
 
-```js
-entryPoints: ['../src/index.ts'],
-tsconfig: '../tsconfig.json'
-```
+Please see <https://typedoc.org/options/configuration> for general TypeDoc option configuration.
 
-Additional TypeDoc plugins will need to be explicitly set:
+The following TypeDoc / Markdown plugin options can be passed to config:
 
-```js
-plugin: ['typedoc-plugin-xyz'];
+- [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).
+
+The following typedoc-plugin-markdown options are preset with the plugin.
+
+```json
+{
+  "out": "./docs/api",
+  "hideInPageTOC": true,
+  "hideBreadcrumbs": true,
+  "hidePageHeader": true,
+  "entryFileName": "index.md"
+}
 ```
 
-#### Other config options
+### Plugin options
 
-TypeDoc options can also be declared:
+Options specific to the plugin should also be declared in the same object.
 
-- Using a `typedoc.json` file.
-- Under the `typedocOptions` key in `tsconfig.json`.
+#### `--sidebar`
 
-> Note: Options declared in this manner will take priority and overwrite options declared in `docusaurus.config.js`.
+`sidebar.autoConfiguration`
 
-### Plugin options
+Set to `false` to disable sidebar generation. Defaults to `true`.
 
-Options specific to the plugin should also be declared in the same object.
+`sidebar.filteredIds`
 
-| 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.                 |
+Ids of pages to be filtered from the sidebar. This would typically be used to filter README or index pages from the sidebar.
 
-### An example configuration
+`sidebar.pretty`
 
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        // TypeDoc options
-        entryPoints: ['../src/index.ts'],
-        tsconfig: '../tsconfig.json',
-        plugin: ['typedoc-plugin-xyz'],
-
-        // Plugin options
-        out: 'api-xyz',
-        sidebar: {
-          categoryLabel: 'API XYZ',
-          position: 0,
-          fullNames: true,
-        },
-      },
-    ],
-  ],
-};
-```
+Pretty format the sidebar JSON.
 
-## Recipes
+## Sidebar
 
-### Sidebar and Navbar
+> Previous versions of this plugin recommended an `autogenerated` sidebar configuration. However we have decided it is more deterministic and configurable to use a manual sidebar configuration with a generated sidebar file.
 
-#### Sidebar
+A docusaurus sidebar file `typedoc-sidebar.cjs` is published to the relevant output directory along with the generated markdown documentation.
 
-`sidebars.js` can be configured in following ways:
+This file should be referenced in `sidebars.js` using a sidebar slice and can be configured in following ways:
 
-1. Generate the entire sidebar from file structure of your docs folder (default behaviour):
+1.  Display sidebar on the root:
 
 ```js
 module.exports = {
-  sidebar: [
-    {
-      type: 'autogenerated',
-      dirName: '.', // '.' means the docs folder
-    },
-  ],
+  typedocSidebar: require('./docs/api/typedoc-sidebar.cjs'),
 };
 ```
 
-2. Alternatively, if you wish to manually control other parts of your sidebar you can use a slice for the TypeDoc sidebar.
+2.  Display the sidebar inside a category:
 
-> note: `sidebar.categoryLabel` and `sidebar.position` options are ignored with this implementation)
+```js
+module.exports = {
+  typedocSidebar: {
+    'Typedoc Docs': require('./docs/api/typedoc-sidebar.js'),
+  },
+};
+```
+
+3.  Display the sidebar inside a linked category
+
+> Note the linked category page can be removed from sidebar using [`sidebar.filteredIds`]().
 
 ```js
 module.exports = {
-  sidebar: {
-    'Category 1': ['doc1', 'doc2', 'doc3'],
-    API: [
-      {
-        type: 'autogenerated',
-        dirName: 'api', // 'api' is the 'out' directory
+  typedocSidebar: [
+    {
+      type: 'category',
+      label: 'Typedoc Docs',
+      link: {
+        type: 'doc',
+        id: 'api/index',
       },
-    ],
-  },
+      items: require('./docs/api/typedoc-sidebar.js'),
+    },
+  ],
 };
 ```
 
-Please see https://docusaurus.io/docs/sidebar for sidebar documentation.
+Please see <https://docusaurus.io/docs/sidebar> for sidebar documentation.
 
-#### Navbar
+## Other configuration
+
+### Navbar
 
 A navbar item can be configured in `themeConfig` options in `docusaurus.config.js`:
 
@@ -188,28 +187,7 @@ 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
-      }
-    ]
-]
-```
+Please see <https://docusaurus.io/docs/api/themes/configuration#navbar-items> for navbar documentation.
 
 ### Multi instance
 
@@ -242,9 +220,20 @@ module.exports = {
 };
 ```
 
+`sidebars.js`
+
+```js
+module.exports = {
+  typedocSidebar: {
+    'API 1': require('./docs/api-1/typedoc-sidebar.js'),
+    'API 2': require('./docs/api-2/typedoc-sidebar.js'),
+  },
+};
+```
+
 ### Watch mode
 
-Watching files is supported by passing in the `watch: true` option see [https://typedoc.org/guides/options/#watch](https://typedoc.org/guides/options/#watch).
+Watching files is supported by passing in the `watch: true` option see <https://typedoc.org/guides/options/#watch>.
 
 Targetting the option in development mode only can be achieved using Node.js Environment Variables:
 
@@ -272,26 +261,9 @@ module.exports = {
 };
 ```
 
-### Monorepo setup
-
-`docusaurus.config.js`
+### Frontmatter
 
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        entryPoints: ['../packages/package-a', '../packages/package-b'],
-        entryPointStrategy: 'packages',
-        sidebar: {
-          fullNames: true,
-        },
-      },
-    ],
-  ],
-};
-```
+To add frontmatter to page please use [typedoc-plugin-frontmatter](https://github.com/tgreyuk/typedoc-plugin-frontmatter#typedoc-plugin-frontmatter) and add options exposed by the plugin to the config.
 
 ## License
 

package/dist/index.d.ts

@@ -1 +1,2 @@
+export { PluginOptions } from './models';
 export { default } from './plugin';

package/dist/models.d.ts

@@ -0,0 +1,10 @@
+import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
+export interface PluginOptions extends TypedocPluginMarkdownOptions {
+    id: string;
+    sidebar: Partial<SidebarOptions>;
+}
+export interface SidebarOptions {
+    autoConfiguration: boolean;
+    pretty: boolean;
+    filteredIds: string[];
+}

package/dist/options.d.ts

@@ -1,2 +1,3 @@
-import { PluginOptions } from './types';
-export declare const getPluginOptions: (opts: Partial<PluginOptions>) => PluginOptions;
+import { Application } from 'typedoc';
+export declare function getPluginOptions(opts: Record<string, any>): Record<string, any>;
+export declare function setOptions(app: Application, options: any): void;

package/dist/options.js

@@ -1,29 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginOptions = void 0;
+exports.setOptions = exports.getPluginOptions = void 0;
 const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
-    docsRoot: 'docs',
-    out: 'api',
-    cleanOutputDir: true,
+    out: './docs/api',
+    hideInPageTOC: true,
+    hideBreadcrumbs: true,
+    hidePageHeader: true,
+    entryFileName: 'index.md',
     sidebar: {
-        fullNames: false,
-        categoryLabel: 'API',
-        collapsed: true,
-        indexLabel: 'Overview',
-        position: null,
         autoConfiguration: true,
+        pretty: false,
+        filteredIds: [],
     },
-    hideInPageTOC: true,
-    hideBreadcrumbs: true,
-    hidePageTitle: false,
-    entryDocument: 'index.md',
-    plugin: ['none'],
-    watch: false,
-    theme: 'docusaurus',
-    enableFrontmatter: true,
+    plugin: ['typedoc-plugin-markdown'],
 };
-const getPluginOptions = (opts) => {
+function getPluginOptions(opts) {
     const options = {
         ...DEFAULT_PLUGIN_OPTIONS,
         ...opts,
@@ -31,7 +23,16 @@ const getPluginOptions = (opts) => {
             ...DEFAULT_PLUGIN_OPTIONS.sidebar,
             ...opts.sidebar,
         },
+        plugin: [
+            ...new Set([...DEFAULT_PLUGIN_OPTIONS.plugin, ...(opts.plugin || [])]),
+        ],
     };
     return options;
-};
+}
 exports.getPluginOptions = getPluginOptions;
+function setOptions(app, options) {
+    for (const [key, val] of Object.entries(options)) {
+        app.options.setValue(key, val);
+    }
+}
+exports.setOptions = setOptions;

package/dist/plugin.d.ts

@@ -1,6 +1,9 @@
-import { PluginOptions } from './types';
+import { PluginOptions } from '.';
 export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
     name: string;
     loadContent(): Promise<void>;
     extendCli(cli: any): void;
 };
+export declare function writeFileSync(fileName: string, data: string): void;
+export declare function normalizePath(path: string): string;
+export declare function removeDir(path: string): void;

package/dist/plugin.js

@@ -23,12 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeDir = exports.normalizePath = exports.writeFileSync = void 0;
+const fs = __importStar(require("fs"));
 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 sidebar_1 = require("./sidebar");
+// store list of plugin ids when running multiple instances
 const apps = [];
 function pluginDocusaurus(context, opts) {
     return {
@@ -36,7 +37,7 @@ function pluginDocusaurus(context, opts) {
         async loadContent() {
             if (opts.id && !apps.includes(opts.id)) {
                 apps.push(opts.id);
-                generateTypedoc(context, opts);
+                await generateTypedoc(context, opts);
             }
         },
         extendCli(cli) {
@@ -46,6 +47,7 @@ function pluginDocusaurus(context, opts) {
                 .action(async () => {
                 var _a;
                 (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.plugins.forEach((pluginConfig) => {
+                    // Check PluginConfig is typed to [string, PluginOptions]
                     if (pluginConfig && typeof pluginConfig[1] === 'object') {
                         generateTypedoc(context, pluginConfig[1]);
                     }
@@ -55,22 +57,50 @@ function pluginDocusaurus(context, opts) {
     };
 }
 exports.default = pluginDocusaurus;
+/**
+ * Initiates a new typedoc Application bootstraped with plugin options
+ */
 async function generateTypedoc(context, opts) {
+    var _a, _b;
     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 { id, sidebar, ...optionsPassedToTypeDoc } = options;
+    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    const outputDir = app.options.getValue('out');
+    if (options.cleanOutputDir) {
+        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 (((_b = (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.markdown) === null || _b === void 0 ? void 0 : _b.format) !== 'mdx') {
+        app.renderer.on(typedoc_1.PageEvent.END, (event) => {
+            var _a;
+            event.contents = (_a = event.contents) === null || _a === void 0 ? void 0 : _a.replace(/\\</g, '<');
+        });
+    }
+    if (sidebar === null || sidebar === void 0 ? void 0 : sidebar.autoConfiguration) {
+        app.renderer.postRenderAsyncJobs.push(async (output) => {
+            const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
+            const baseDir = path
+                .relative(siteDir, outputDir)
+                .split(path.sep)
+                .slice(1)
+                .join(path.sep);
+            const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, sidebar.filteredIds);
+            fs.writeFileSync(sidebarPath, `// @ts-check
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const typedocSidebar = { items: ${JSON.stringify(sidebarJson, null, sidebar.pretty ? 2 : 0)}};
+module.exports = typedocSidebar.items;`);
+        });
+    }
+    const project = await app.convert();
+    // if project is undefined typedoc has a problem - error logging will be supplied by typedoc.
     if (!project) {
-        return;
+        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) {
+    if (app.options.getValue('watch')) {
         app.convertAndWatch(async (project) => {
             await app.generateDocs(project, outputDir);
         });
@@ -79,3 +109,32 @@ async function generateTypedoc(context, opts) {
         await app.generateDocs(project, outputDir);
     }
 }
+function writeFileSync(fileName, data) {
+    fs.mkdirSync(path.dirname(normalizePath(fileName)), { recursive: true });
+    fs.writeFileSync(normalizePath(fileName), data);
+}
+exports.writeFileSync = writeFileSync;
+function normalizePath(path) {
+    return path.replace(/\\/g, '/');
+}
+exports.normalizePath = normalizePath;
+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/sidebar.d.ts

@@ -0,0 +1,2 @@
+import { NavigationItem } from 'typedoc-plugin-markdown';
+export declare function getSidebar(navigation: NavigationItem[], basePath: string, filteredIds?: string[]): any;

package/dist/sidebar.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSidebar = void 0;
+function getSidebar(navigation, basePath, filteredIds = []) {
+    return navigation
+        .map((navigationItem) => getNavigationItem(navigationItem, basePath, filteredIds))
+        .filter((navItem) => Boolean(navItem));
+}
+exports.getSidebar = getSidebar;
+function getNavigationItem(navigationItem, basePath, filteredIds) {
+    var _a;
+    const id = navigationItem.url
+        ? `${basePath}/${navigationItem.url.replace(/\d+\-/g, '')}`.replace(/(.*).md/, '$1')
+        : null;
+    if ((_a = navigationItem.children) === null || _a === void 0 ? void 0 : _a.length) {
+        return {
+            type: 'category',
+            label: navigationItem.title,
+            items: getSidebar(navigationItem.children, basePath, filteredIds),
+            ...(id && { link: { type: 'doc', id } }),
+        };
+    }
+    return id && !filteredIds.includes(id)
+        ? {
+            type: 'doc',
+            id,
+            label: navigationItem.title,
+        }
+        : null;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.2",
-  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
+  "version": "1.0.0-next.20",
+  "description": "A Docusaurus plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
     "dist/"
@@ -16,15 +16,13 @@
   },
   "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.2"
+    "typedoc-plugin-markdown": ">=4.0.0-next.24"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "npm run lint && npm run build && npm run test",
+    "prepublishOnly": "npm run lint && npm run build",
     "build": "rm -rf ./dist && tsc",
-    "build-and-test": "npm run build && npm run test",
-    "test": "jest --colors"
+    "task:docs": "node ./tasks/docs.mjs"
   },
   "author": "Thomas Grey",
   "license": "MIT",
@@ -35,5 +33,8 @@
     "markdown",
     "typescript",
     "api"
-  ]
+  ],
+  "devDependencies": {
+    "@docusaurus/types": "^3.0.0"
+  }
 }

package/dist/navigation.d.ts

@@ -1,13 +0,0 @@
-import { ReflectionKind } from 'typedoc';
-export declare const CATEGORY_POSITION: {
-    2: number;
-    4: number;
-    8: number;
-    128: number;
-    256: number;
-    4194304: number;
-    32: number;
-    64: number;
-    2097152: number;
-};
-export declare function getKindPlural(kind: ReflectionKind): string;

package/dist/navigation.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKindPlural = 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,
-    [typedoc_1.ReflectionKind.Enum]: 2,
-    [typedoc_1.ReflectionKind.Class]: 3,
-    [typedoc_1.ReflectionKind.Interface]: 4,
-    [typedoc_1.ReflectionKind.TypeAlias]: 5,
-    [typedoc_1.ReflectionKind.Variable]: 6,
-    [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/render.d.ts

@@ -1,5 +0,0 @@
-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,77 +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 });
-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: 'sidebar',
-        type: typedoc_1.ParameterType.Mixed,
-    });
-};
-function removeDir(path) {
-    fs.rmSync(path, { recursive: true, force: true });
-}
-exports.removeDir = removeDir;

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;

package/dist/theme.d.ts

@@ -1,13 +0,0 @@
-import { DeclarationReflection, PageEvent, Renderer, RendererEvent } from 'typedoc';
-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;
-}

package/dist/theme.js

@@ -1,97 +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");
-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) => {
-            const yaml = [`label: "${label}"`];
-            if (position !== null) {
-                yaml.push(`position: ${position}`);
-            }
-            if (!collapsed) {
-                yaml.push(`collapsed: false`);
-            }
-            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,
-        });
-    }
-    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, '<');
-        }
-    }
-    onRendererEnd(renderer) {
-        if (this.sidebar.autoConfiguration) {
-            this.writeCategoryYaml(renderer.outputDirectory, this.sidebar.categoryLabel, this.sidebar.position, this.sidebar.collapsed);
-            this.loopAndWriteCategories(renderer.outputDirectory);
-        }
-    }
-    loopAndWriteCategories(path) {
-        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;
-                })
-                    .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);
-                }
-                this.loopAndWriteCategories(fullPath);
-            }
-        });
-    }
-}
-__decorate([
-    (0, typedoc_1.BindOption)('sidebar')
-], DocusaurusTheme.prototype, "sidebar", void 0);
-exports.DocusaurusTheme = DocusaurusTheme;

package/dist/types.d.ts

@@ -1,36 +0,0 @@
-export interface PluginOptions {
-    id: string;
-    docsRoot: string;
-    out: string;
-    sidebar: SidebarOptions;
-    readmeTitle?: string;
-    globalsTitle?: string;
-    plugin: string[];
-    readme?: string;
-    disableOutputCheck?: boolean;
-    cleanOutputDir?: boolean;
-    entryPoints?: string[];
-    watch: boolean;
-    hideInPageTOC: boolean;
-    hideBreadcrumbs: boolean;
-    hidePageTitle: boolean;
-    entryDocument: string;
-    includeExtension?: boolean;
-    theme?: string;
-    enableFrontmatter: boolean;
-}
-export type FrontMatter = Record<string, string | boolean | number | null> | undefined;
-export interface SidebarOptions {
-    fullNames?: boolean;
-    categoryLabel: string;
-    collapsed: boolean;
-    indexLabel?: string;
-    position: number | null;
-    autoConfiguration: boolean;
-}
-export interface SidebarCategory {
-    type: string;
-    label: string;
-    items: SidebarItem[];
-}
-export type SidebarItem = SidebarCategory | string;