fix: Use TypeDoc 'defineTheme' to register docusaurus theme

typedoc2md · Jan 9, 2022 · ab5878d · ab5878d
1 parent 2c22b84
commit ab5878d
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/packages/docusaurus-plugin-typedoc/src/options.ts b/packages/docusaurus-plugin-typedoc/src/options.ts
@@ -18,6 +18,7 @@ const DEFAULT_PLUGIN_OPTIONS: PluginOptions = {
   plugin: ['none'],
   watch: false,
   indexSlug: undefined,
+  theme: 'docusaurus',
 };
 
 export const getPluginOptions = (

diff --git a/packages/docusaurus-plugin-typedoc/src/plugin.ts b/packages/docusaurus-plugin-typedoc/src/plugin.ts
@@ -4,6 +4,8 @@ import { Application } from 'typedoc';
 import { load } from 'typedoc-plugin-markdown';
 import { getPluginOptions } from './options';
 import { bootstrap, removeDir } from './render';
+
+import { DocusaurusTheme } from './theme';
 import { PluginOptions } from './types';
 
 // store list of plugin ids when running multiple instances
@@ -29,7 +31,7 @@ export default function pluginDocusaurus(
 
         const app = new Application();
 
-        app.options.setValue('theme', path.resolve(__dirname));
+        app.renderer.defineTheme('docusaurus', DocusaurusTheme);
 
         load(app);
 

diff --git a/packages/docusaurus-plugin-typedoc/src/render.ts b/packages/docusaurus-plugin-typedoc/src/render.ts
@@ -19,7 +19,13 @@ export const bootstrap = (app: Application, options: PluginOptions) => {
   app.bootstrap(options);
 };
 
-async function render(project: ProjectReflection, outputDirectory: string) {
+export async function render(
+  project: ProjectReflection,
+  outputDirectory: string,
+) {
+  if (!this.prepareTheme()) {
+    return;
+  }
   const output = new RendererEvent(
     RendererEvent.BEGIN,
     outputDirectory,

diff --git a/packages/docusaurus-plugin-typedoc/src/types.ts b/packages/docusaurus-plugin-typedoc/src/types.ts
@@ -15,6 +15,7 @@ export interface PluginOptions {
   hidePageTitle: boolean;
   entryDocument: string;
   indexSlug?: string;
+  theme?: string;
 }
 
 export interface FrontMatter {

diff --git a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/options.spec.ts.snap b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/options.spec.ts.snap
@@ -39,6 +39,7 @@ Object {
     "position": null,
     "readmeLabel": "Readme",
   },
+  "theme": "docusaurus",
   "watch": false,
 }
 `;