docusaurus-plugin-typedoc 0.19.2 → 0.20.1

package/README.md

@@ -67,7 +67,7 @@ Once built the docs will be available at `/docs/api` (or equivalent out director
 
 ### TypeDoc options
 
-To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/guides/options/) to the config.
+To configure TypeDoc, pass any relevant [TypeDoc options](https://typedoc.org/options/) to the config.
 
 At a minimum the `entryPoints` and `tsconfig` options will need to be set.
 

package/dist/options-reader.d.ts

@@ -0,0 +1,7 @@
+import { Options, OptionsReader } from 'typedoc';
+export declare class MarkdownThemeOptionsReader implements OptionsReader {
+    name: string;
+    readonly order = 1000;
+    readonly supportsPackages = false;
+    read(container: Options): void;
+}

package/dist/options-reader.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MarkdownThemeOptionsReader = void 0;
+class MarkdownThemeOptionsReader {
+    constructor() {
+        this.name = 'markdown-theme-reader';
+        this.order = 1000;
+        this.supportsPackages = false;
+    }
+    read(container) {
+        container.setValue('theme', 'markdown');
+    }
+}
+exports.MarkdownThemeOptionsReader = MarkdownThemeOptionsReader;

package/dist/options.js

@@ -25,6 +25,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
     indexSlug: undefined,
     theme: 'docusaurus',
     frontmatter: undefined,
+    plugin: ['typedoc-plugin-markdown'],
 };
 const getPluginOptions = (opts) => {
     const options = {
@@ -34,6 +35,9 @@ const getPluginOptions = (opts) => {
             ...DEFAULT_PLUGIN_OPTIONS.sidebar,
             ...opts.sidebar,
         },
+        plugin: [
+            ...new Set([...DEFAULT_PLUGIN_OPTIONS.plugin, ...(opts.plugin || [])]),
+        ],
     };
     return options;
 };

package/dist/plugin.js

@@ -25,7 +25,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 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");
@@ -59,14 +58,16 @@ 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 { id, docsRoot, sidebar, frontmatter, includeExtension, indexSlug, ...optionsPassedToTypeDoc } = options;
     if (opts.cleanOutputDir) {
         (0, render_1.removeDir)(outputDir);
     }
-    const app = new typedoc_1.Application();
+    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    (0, render_1.addTypedocDeclarations)(app);
+    setOptions(app, options);
     app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
-    (0, typedoc_plugin_markdown_1.load)(app);
-    await (0, render_1.bootstrap)(app, options);
-    const project = app.convert();
+    app.renderer.render = render_1.render;
+    const project = await app.convert();
     if (!project) {
         return;
     }
@@ -79,3 +80,8 @@ async function generateTypedoc(context, opts) {
         await app.generateDocs(project, outputDir);
     }
 }
+function setOptions(app, options, reportErrors = true) {
+    for (const [key, val] of Object.entries(options)) {
+        app.options.setValue(key, val);
+    }
+}

package/dist/render.d.ts

@@ -1,5 +1,4 @@
 import { Application, ProjectReflection } from 'typedoc';
-import { PluginOptions } from './types';
-export declare function bootstrap(app: Application, options: PluginOptions): Promise<void>;
 export declare function render(project: ProjectReflection, outputDirectory: string): Promise<void>;
+export declare const addTypedocDeclarations: (app: Application) => void;
 export declare function removeDir(path: string): void;

package/dist/render.js

@@ -23,16 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeDir = exports.render = exports.bootstrap = void 0;
+exports.removeDir = exports.addTypedocDeclarations = exports.render = void 0;
 const fs = __importStar(require("fs"));
 const typedoc_1 = require("typedoc");
-async function bootstrap(app, options) {
-    addTypedocReaders(app);
-    addTypedocDeclarations(app);
-    app.renderer.render = render;
-    await app.bootstrapWithPlugins(options);
-}
-exports.bootstrap = bootstrap;
 async function render(project, outputDirectory) {
     var _a;
     if (!this.prepareTheme()) {
@@ -49,10 +42,6 @@ async function render(project, outputDirectory) {
     }
 }
 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',
@@ -84,6 +73,7 @@ const addTypedocDeclarations = (app) => {
         type: typedoc_1.ParameterType.Mixed,
     });
 };
+exports.addTypedocDeclarations = addTypedocDeclarations;
 function removeDir(path) {
     if (fs.existsSync(path)) {
         const files = fs.readdirSync(path);

package/dist/theme.js

@@ -45,7 +45,6 @@ const CATEGORY_POSITION = {
     [typedoc_1.ReflectionKind.TypeAlias]: 5,
     [typedoc_1.ReflectionKind.Variable]: 6,
     [typedoc_1.ReflectionKind.Function]: 7,
-    [typedoc_1.ReflectionKind.ObjectLiteral]: 8,
 };
 class DocusaurusTheme extends theme_1.MarkdownTheme {
     constructor(renderer) {

package/dist/types.d.ts

@@ -5,7 +5,7 @@ export interface PluginOptions {
     sidebar: SidebarOptions;
     readmeTitle?: string;
     globalsTitle?: string;
-    plugin?: string[];
+    plugin: string[];
     readme?: string;
     disableOutputCheck?: boolean;
     cleanOutputDir?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "0.19.2",
+  "version": "0.20.1",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [