docusaurus-plugin-typedoc 1.0.0-next.21 → 1.0.0-next.23

package/dist/options.js

@@ -8,6 +8,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
     hideBreadcrumbs: true,
     hidePageHeader: true,
     entryFileName: 'index.md',
+    theme: 'docusaurus',
     sidebar: {
         autoConfiguration: true,
         pretty: false,

package/dist/plugin.js

@@ -29,6 +29,7 @@ const path = __importStar(require("path"));
 const typedoc_1 = require("typedoc");
 const options_1 = require("./options");
 const sidebar_1 = require("./sidebar");
+const theme_1 = require("./theme");
 // store list of plugin ids when running multiple instances
 const apps = [];
 function pluginDocusaurus(context, opts) {
@@ -66,6 +67,7 @@ async function generateTypedoc(context, opts) {
     const options = (0, options_1.getPluginOptions)(opts);
     const { id, sidebar, ...optionsPassedToTypeDoc } = options;
     const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    app.renderer.defineTheme('docusaurus', theme_1.DocusuaurusTheme);
     const outputDir = app.options.getValue('out');
     if (options.cleanOutputDir) {
         removeDir(outputDir);

package/dist/sidebar.js

@@ -19,7 +19,7 @@ function getNavigationItem(navigationItem, basePath, filteredIds, numberPrefixPa
         return {
             type: 'category',
             label: navigationItem.title,
-            items: getSidebar(navigationItem.children, basePath, filteredIds),
+            items: getSidebar(navigationItem.children, basePath, filteredIds, numberPrefixParser),
             ...(id && { link: { type: 'doc', id } }),
         };
     }

package/dist/theme.d.ts

@@ -0,0 +1,9 @@
+import { PageEvent, Reflection, SomeType } from 'typedoc';
+import { MarkdownTheme, MarkdownThemeRenderContext } from 'typedoc-plugin-markdown';
+export declare class DocusuaurusTheme extends MarkdownTheme {
+    getRenderContext(pageEvent: PageEvent<Reflection>): ThemeRenderContext;
+}
+declare class ThemeRenderContext extends MarkdownThemeRenderContext {
+    typeArguments: (typeArguments: SomeType[]) => string;
+}
+export {};

package/dist/theme.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocusuaurusTheme = void 0;
+const typedoc_1 = require("typedoc");
+const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
+class DocusuaurusTheme extends typedoc_plugin_markdown_1.MarkdownTheme {
+    getRenderContext(pageEvent) {
+        return new ThemeRenderContext(pageEvent, this.application.options);
+    }
+}
+exports.DocusuaurusTheme = DocusuaurusTheme;
+class ThemeRenderContext extends typedoc_plugin_markdown_1.MarkdownThemeRenderContext {
+    constructor() {
+        super(...arguments);
+        // adds space around type arguments as docusaurus generates broken links without it in certain use-cases (see https://github.com/facebook/docusaurus/issues/9518)
+        this.typeArguments = (typeArguments) => {
+            return `\\< ${typeArguments
+                .map((typeArgument) => typeArgument instanceof typedoc_1.ReflectionType
+                ? this.reflectionType(typeArgument)
+                : this.someType(typeArgument))
+                .join(', ')} \\>`;
+        };
+    }
+}

package/package.json

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