docusaurus-plugin-typedoc 1.0.0-next.11 → 1.0.0-next.13

package/README.md

@@ -93,7 +93,6 @@ The following typedoc-plugin-markdown options are preset with the plugin.
   "hideBreadcrumbs": true,
   "hidePageHeader": true,
   "entryFileName": "index.md",
-  "globalsPageStrategy": "skip",
   "includeFileNumberPrefixes": true
 }
 ```
@@ -106,15 +105,19 @@ Options specific to the plugin should also be declared in the same object.
 
 `sidebar.autoConfiguration`
 
-Set to `false` to disable sidebar generation. Defaults to `true`.
+Set to `false` to disable sidebar metadata added to frontmatter. Defaults to `true`.
 
 `sidebar.categoryLabel`
 
-The sidebar main parent category label. Defaults to `API`.
+The sidebar main parent category label. Defaults to entry page title.
+
+`sidebar.readmeLabel`
+
+The label of the readme page. Defaults to the h1 title of the readme page. Ignored if `readme=none`.
 
 `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`.
+The label of the index page. Defaults to the index page title.
 
 `sidebar.position`
 
@@ -125,7 +128,7 @@ The position of the sidebar in the tree.
 The Docusaurus docs folder root. Use `./` if no root folder specified. Defaults to `./docs`.
 
 ```shell
---docsRoot <path/to/vitepress-docs/>
+--docsRoot <path/to/docs-dir/>
 ```
 
 ### An example configuration
@@ -143,17 +146,20 @@ module.exports = {
 
         // Plugin options
         out: 'api-xyz',
-        sidebar: {
-          categoryLabel: 'API XYZ',
-          position: 0,
-          fullNames: true,
-        },
       },
     ],
   ],
 };
 ```
 
+## Typing the config file
+
+The config can be typed using JSDoc type annotations. See https://docusaurus.io/docs/typescript-support#typing-config.
+
+```js
+/** @type {import('docusaurus-plugin-typedoc').PluginOptions} */
+```
+
 ## 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).

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,91 +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 typedoc_plugin_frontmatter_1 = require("typedoc-plugin-frontmatter");
-const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
-const options_1 = require("./options");
-const renderer_1 = require("./renderer");
-// store list of plugin ids when running multiple instances
-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) => {
-                    // 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 bootstraped with plugin options
- */
-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);
-    (0, typedoc_plugin_markdown_1.load)(app);
-    (0, typedoc_plugin_frontmatter_1.load)(app);
-    await app.bootstrapWithPlugins(optionsPassedToTypeDoc);
-    const project = 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();
-    }
-    if (app.options.getValue('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,7 +1,8 @@
-export interface PluginOptions {
+import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
+export interface PluginOptions extends TypedocPluginMarkdownOptions {
     id: string;
     docsRoot: string;
-    sidebar: SidebarOptions;
+    sidebar: Partial<SidebarOptions>;
 }
 export interface SidebarOptions {
     autoConfiguration: boolean;

package/dist/plugin.d.ts

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

package/dist/plugin.js

@@ -0,0 +1,91 @@
+"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 path = __importStar(require("path"));
+const typedoc_1 = require("typedoc");
+const typedoc_plugin_frontmatter_1 = require("typedoc-plugin-frontmatter");
+const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");
+const options_1 = require("./options");
+const renderer_1 = require("./renderer");
+// store list of plugin ids when running multiple instances
+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) => {
+                    // 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 bootstraped with plugin options
+ */
+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);
+    (0, typedoc_plugin_markdown_1.load)(app);
+    (0, typedoc_plugin_frontmatter_1.load)(app);
+    await app.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    const project = 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();
+    }
+    if (app.options.getValue('watch')) {
+        app.convertAndWatch(async (project) => {
+            await app.generateDocs(project, outputDir);
+        });
+    }
+    else {
+        await app.generateDocs(project, outputDir);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.11",
+  "version": "1.0.0-next.13",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -15,10 +15,12 @@
     "directory": "packages/docusaurus-plugin-typedoc"
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
-  "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.13",
+  "dependencies": {
     "typedoc-plugin-frontmatter": ">=0.0.2"
   },
+  "peerDependencies": {
+    "typedoc-plugin-markdown": ">=4.0.0-next.14"
+  },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
     "prepublishOnly": "npm run lint && npm run build",