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

package/README.md

@@ -1,296 +1,19 @@
 # docusaurus-plugin-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?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.docusaurus-plugin-typedoc.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.docusaurus-plugin-typedoc.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)
-
-## 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.
-- Adds some basic frontmatter to pages and exposes the ability to configure frontmatter further.
+> A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.
 
 ## 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 docusaurus-plugin-typedoc typedoc typedoc-plugin-markdown@next typedoc-plugin-frontmatter@next --save-dev
-```
-
-## Usage
-
-### Config
-
-Add the plugin to `docusaurus.config.js` and specify the required options (see [options](#options)).
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-
-      // Plugin / TypeDoc options
-      {
-        entryPoints: ['../src/index.ts'],
-        tsconfig: '../tsconfig.json',
-      },
-    ],
-  ],
-};
-```
-
-TypeDoc will be bootstraped with the Docusaurus `start` and `build` [cli commands](https://v2.docusaurus.io/docs/cli):
-
-```javascript
-"start": "docusaurus start",
-"build": "docusaurus build",
-```
-
-Once built the docs will be available at `/docs/api` (or equivalent out directory).
-
-### 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
-```
-
-## 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
-
-The following TypeDoc / Markdown plugin options can be passed to config:
-
-- [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": "api",
-  "hideInPageTOC": true,
-  "hideBreadcrumbs": true,
-  "hidePageHeader": true,
-  "entryDocument": "index.md",
-  "includeFileNumberPrefixes": true
-}
-```
-
-### Plugin options
-
-Options specific to the plugin should also be declared in the same object.
-
-#### `--sidebar`
-
-`sidebar.autoConfiguration`
-
-Set to `false` to disable sidebar generation. Defaults to `true`.
-
-`sidebar.categoryLabel`
-
-The sidebar main parent category label. Defaults to `API`.
-
-`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`.
-
 ```shell
---docsRoot <path/to/vitepress-docs/>
-```
-
-### An example configuration
-
-```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,
-        },
-      },
-    ],
-  ],
-};
-```
-
-## 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
-
-#### Sidebar
-
-`sidebars.js` can be configured in following ways:
-
-1. Generate the entire sidebar from file structure of your docs folder (default behaviour):
-
-```js
-module.exports = {
-  sidebar: [
-    {
-      type: 'autogenerated',
-      dirName: '.', // '.' means the docs folder
-    },
-  ],
-};
-```
-
-2. Alternatively, if you wish to manually control other parts of your sidebar you can use a slice for the TypeDoc sidebar.
-
-> note: `sidebar.categoryLabel` and `sidebar.position` options are ignored with this implementation)
-
-```js
-module.exports = {
-  sidebar: {
-    'Category 1': ['doc1', 'doc2', 'doc3'],
-    API: [
-      {
-        type: 'autogenerated',
-        dirName: 'api', // 'api' is the 'out' directory
-      },
-    ],
-  },
-};
-```
-
-Please see https://docusaurus.io/docs/sidebar for sidebar documentation.
-
-#### Navbar
-
-A navbar item can be configured in `themeConfig` options in `docusaurus.config.js`:
-
-```js
- themeConfig: {
-    navbar: {
-      items: [
-        {
-        to: 'docs/api/',  // 'api' is the 'out' directory
-        activeBasePath: 'docs',
-        label: 'API',
-        position: 'left',
-      },
-    ],
-  },
-},
-```
-
-Please see https://docusaurus.io/docs/api/themes/configuration#navbar-items for navbar documentation.
-
-### Multi instance
-
-It is possible to build multi TypeDoc instances by passing in multiple configs with unique ids:
-
-`docusaurus.config.js`
-
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        id: 'api-1',
-        entryPoints: ['../api-1/src/index.ts'],
-        tsconfig: '../api-1/tsconfig.json',
-        out: 'api-1',
-      },
-    ],
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        id: 'api-2',
-        entryPoints: ['../api-2/src/index.ts'],
-        tsconfig: '../api-2/tsconfig.json',
-        out: 'api-2',
-      },
-    ],
-  ],
-};
-```
-
-### 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).
-
-Targetting the option in development mode only can be achieved using Node.js Environment Variables:
-
-`package.json`
-
-```json
-"start": "TYPEDOC_WATCH=true docusaurus start",
-"build": "TYPEDOC_WATCH=false docusaurus build",
-```
+  npm install docusaurus-plugin-typedoc --save-dev
+  ```
 
-`docusaurus.config.js`
+## Documentation
 
-```js
-module.exports = {
-  plugins: [
-    [
-      'docusaurus-plugin-typedoc',
-      {
-        entryPoints: ['../src/index.ts'],
-        tsconfig: '../tsconfig.json',
-        watch: process.env.TYPEDOC_WATCH,
-      },
-    ],
-  ],
-};
-```
+Please visit the [https://typedoc-plugin-markdown.org/plugins/docusaurus](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.
 
 ## License
 
-[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/docusaurus-plugin-typedoc/LICENSE)
+MIT

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,81 +1,8 @@
 "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;
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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);
-    }
-}
+exports.default = void 0;
+var plugin_1 = require("./plugin");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(plugin_1).default; } });

package/dist/models.d.ts

@@ -1,24 +1,5 @@
-import { TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
-export interface PluginOptions extends TypedocPluginMarkdownOptions {
+import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
+import { PluginOptions as DocusaurusOptions } from './options/option-types';
+export interface PluginOptions extends TypedocPluginMarkdownOptions, DocusaurusOptions {
     id: string;
-    docsRoot: string;
-    sidebar: SidebarOptions;
 }
-export interface SidebarOptions {
-    categoryLabel: string;
-    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/declarations.d.ts

@@ -0,0 +1,21 @@
+import { ParameterType } from 'typedoc';
+/**
+ * **sidebar.autoConfiguration**
+ *
+ * Set to `false` to disable sidebar generation. Defaults to `true`.
+ *
+ * **sidebar.pretty**
+ *
+ * Pretty format the sidebar JSON.
+ *
+ * Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional information on sidebar setup.
+ *
+ */
+export declare const sidebar: {
+    help: string;
+    type: ParameterType;
+    defaultValue: {
+        autoConfiguration: boolean;
+        pretty: boolean;
+    };
+};

package/dist/options/declarations.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sidebar = void 0;
+const typedoc_1 = require("typedoc");
+const options_1 = require("../options");
+/**
+ * **sidebar.autoConfiguration**
+ *
+ * Set to `false` to disable sidebar generation. Defaults to `true`.
+ *
+ * **sidebar.pretty**
+ *
+ * Pretty format the sidebar JSON.
+ *
+ * Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional information on sidebar setup.
+ *
+ */
+exports.sidebar = {
+    help: 'Configures the autogenerated Docusaurus sidebar.',
+    type: typedoc_1.ParameterType.Mixed,
+    defaultValue: options_1.DEFAULT_SIDEBAR_OPTIONS,
+};

package/dist/options/option-types.d.ts

@@ -0,0 +1,26 @@
+import { ManuallyValidatedOption } from 'typedoc';
+declare module 'typedoc' {
+    interface TypeDocOptionMap {
+        sidebar: ManuallyValidatedOption<Sidebar>;
+    }
+}
+/**
+ * Describes the options declared by the plugin.
+ *
+ * @category Options
+ */
+export interface PluginOptions {
+    /**
+     * Configures the autogenerated Docusaurus sidebar.
+     */
+    sidebar: Sidebar;
+}
+/**
+ *
+ *
+ * @category Options
+ */
+export interface Sidebar {
+    autoConfiguration: boolean;
+    pretty: boolean;
+}

package/dist/options/option-types.js

@@ -0,0 +1,3 @@
+"use strict";
+// THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/options/presets.d.ts

@@ -0,0 +1,8 @@
+declare const _default: {
+    out: string;
+    hideBreadcrumbs: boolean;
+    hidePageHeader: boolean;
+    entryFileName: string;
+    plugin: string[];
+};
+export default _default;

package/dist/options/presets.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    out: './docs/api',
+    hideBreadcrumbs: true,
+    hidePageHeader: true,
+    entryFileName: 'index.md',
+    plugin: ['typedoc-plugin-markdown'],
+};

package/dist/options.d.ts

@@ -1,4 +1,5 @@
-import { Application } from 'typedoc';
-import { PluginOptions } from './models';
-export declare function getPluginOptions(opts: Partial<PluginOptions>): PluginOptions;
-export declare function loadOptions(app: Application): void;
+export declare const DEFAULT_SIDEBAR_OPTIONS: {
+    autoConfiguration: boolean;
+    pretty: boolean;
+};
+export declare function getPluginOptions(opts: Record<string, any>): Record<string, any>;

package/dist/options.js

@@ -1,22 +1,19 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadOptions = exports.getPluginOptions = void 0;
-const typedoc_1 = require("typedoc");
+exports.getPluginOptions = exports.DEFAULT_SIDEBAR_OPTIONS = void 0;
+const presets_1 = __importDefault(require("./options/presets"));
+exports.DEFAULT_SIDEBAR_OPTIONS = {
+    autoConfiguration: true,
+    pretty: false,
+};
 const DEFAULT_PLUGIN_OPTIONS = {
+    ...presets_1.default,
     id: 'default',
-    docsRoot: 'docs',
-    out: 'api',
-    watch: false,
-    plugin: [],
-    hideInPageTOC: true,
-    hideBreadcrumbs: true,
-    hidePageHeader: true,
-    includeFileNumberPrefixes: true,
     sidebar: {
-        categoryLabel: 'API',
-        position: null,
-        autoConfiguration: true,
-        indexLabel: 'Index',
+        ...exports.DEFAULT_SIDEBAR_OPTIONS,
     },
 };
 function getPluginOptions(opts) {
@@ -27,33 +24,10 @@ function getPluginOptions(opts) {
             ...DEFAULT_PLUGIN_OPTIONS.sidebar,
             ...opts.sidebar,
         },
+        plugin: [
+            ...new Set([...DEFAULT_PLUGIN_OPTIONS.plugin, ...(opts.plugin || [])]),
+        ],
     };
     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/plugin.d.ts

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

package/dist/plugin.js

@@ -0,0 +1,114 @@
+"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 fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const options_1 = require("./options");
+const options = __importStar(require("./options/declarations"));
+const sidebar_1 = require("./sidebar");
+// store list of plugin ids when running multiple instances
+const apps = [];
+async function pluginDocusaurus(context, opts) {
+    const PLUGIN_NAME = 'docusaurus-plugin-typedoc';
+    if (opts.id && !apps.includes(opts.id)) {
+        apps.push(opts.id);
+        await generateTypedoc(context, opts);
+    }
+    return {
+        name: PLUGIN_NAME,
+        extendCli(cli) {
+            cli
+                .command('generate-typedoc')
+                .description(`[${PLUGIN_NAME}] Generate TypeDoc docs independently of the Docusaurus build process.`)
+                .action(async () => {
+                context.siteConfig?.plugins.forEach((pluginConfig) => {
+                    // Check PluginConfig is typed to [string, PluginOptions]
+                    if (pluginConfig && typeof pluginConfig[1] === 'object') {
+                        generateTypedoc(context, pluginConfig[1]);
+                    }
+                });
+            });
+        },
+    };
+}
+exports.default = pluginDocusaurus;
+/**
+ * Initiates a new typedoc Application bootstrapped with plugin options
+ */
+async function generateTypedoc(context, opts) {
+    const { siteDir } = context;
+    const pluginOptions = (0, options_1.getPluginOptions)(opts);
+    const { id, sidebar, ...optionsPassedToTypeDoc } = pluginOptions;
+    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    Object.entries(options).forEach(([name, option]) => {
+        app.options.addDeclaration({
+            name,
+            ...option,
+        });
+    });
+    // attempt to handle docusaurus linkify bug https://github.com/facebook/docusaurus/issues/9048
+    app.renderer.on(typedoc_1.PageEvent.END, (event) => {
+        event.contents = event.contents
+            ?.replace(/\)\.\[/g, ') . [')
+            .replace(/\\<\[/g, ' \\<[');
+    });
+    const outputDir = app.options.getValue('out');
+    if (sidebar?.autoConfiguration) {
+        const docsPreset = context.siteConfig?.presets?.find((preset) => Boolean(preset[1]?.docs));
+        app.renderer.postRenderAsyncJobs.push(async (output) => {
+            if (output.navigation) {
+                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, docsPreset ? docsPreset[1]?.docs?.numberPrefixParser : null);
+                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) {
+        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(1);
+    }
+    if (app.options.getValue('watch')) {
+        app.convertAndWatch(async (project) => {
+            await app.generateDocs(project, outputDir);
+        });
+    }
+    else {
+        await app.generateDocs(project, outputDir);
+    }
+}

package/dist/sidebar.d.ts

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

package/dist/sidebar.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSidebar = void 0;
+function getSidebar(navigation, basePath, numberPrefixParser) {
+    return navigation
+        .map((navigationItem) => getNavigationItem(navigationItem, basePath, numberPrefixParser))
+        .filter((navItem) => Boolean(navItem));
+}
+exports.getSidebar = getSidebar;
+function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
+    const parsedUrl = numberPrefixParser === false
+        ? navigationItem.path
+        : navigationItem.path?.replace(/\d+\-/g, '');
+    const getId = () => {
+        const idParts = [];
+        if (basePath.length > 0) {
+            idParts.push(basePath);
+        }
+        if (parsedUrl) {
+            idParts.push(parsedUrl.replace(/\\/g, '/'));
+        }
+        if (navigationItem.path) {
+            return idParts.join('/').replace(/(.*)\.\w+$/, '$1');
+        }
+        return null;
+    };
+    const id = getId();
+    if (navigationItem.children?.length) {
+        return {
+            type: 'category',
+            label: `${navigationItem.title}`,
+            items: getSidebar(navigationItem.children, basePath, numberPrefixParser),
+            ...(id && {
+                link: {
+                    type: 'doc',
+                    id,
+                },
+            }),
+        };
+    }
+    return id
+        ? {
+            type: 'doc',
+            id,
+            label: `${navigationItem.title}`,
+        }
+        : null;
+}

package/package.json

@@ -1,39 +1,41 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.9",
-  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
+  "version": "1.0.0",
+  "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "main": "dist/index.js",
   "files": [
     "dist/"
   ],
   "bugs": {
-    "url": "https://github.com/tgreyuk/typedoc-plugin-markdown/issues"
+    "url": "https://github.com/typedoc2md/typedoc-plugin-markdown/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tgreyuk/typedoc-plugin-markdown.git",
+    "url": "git+https://github.com/typedoc2md/typedoc-plugin-markdown.git",
     "directory": "packages/docusaurus-plugin-typedoc"
   },
-  "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
+  "homepage": "http://typedoc.org/plugins/docusaurus",
   "peerDependencies": {
-    "typedoc-plugin-frontmatter": "^0.0.2",
-    "typedoc-plugin-markdown": ">=4.0.0-next.11"
+    "typedoc-plugin-markdown": ">=4.0.0"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "npm run lint && npm run build && npm run test",
-    "build": "rm -rf ./dist && tsc",
-    "build-and-test": "npm run build && npm run test",
-    "test": "jest --colors"
+    "prebuild": "rm -rf dist && prebuild-options",
+    "prepublishOnly": "npm run lint && npm run build",
+    "build": "tsc",
+    "pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
+    "test": "jest",
+    "test:update": "npm run build && npm test -- -u"
   },
   "author": "Thomas Grey",
   "license": "MIT",
   "keywords": [
     "docusaurus",
     "typedoc",
-    "plugin",
-    "markdown",
-    "typescript",
-    "api"
-  ]
+    "plugin"
+  ],
+  "devDependencies": {
+    "@docusaurus/core": "^3.2.1",
+    "@docusaurus/types": "^3.2.1"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2016 Thomas Grey
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/renderer.d.ts

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

package/dist/renderer.js

@@ -1,85 +0,0 @@
-"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,
-    };
-}