docusaurus-plugin-typedoc 1.0.0-next.16 → 1.0.0-next.17

package/README.md

@@ -92,7 +92,7 @@ The following typedoc-plugin-markdown options are preset with the plugin.
 
 ```json
 {
-  "out": "api",
+  "out": "./docs/api",
   "hideInPageTOC": true,
   "hideBreadcrumbs": true,
   "hidePageHeader": true,
@@ -112,19 +112,11 @@ Set to `false` to disable sidebar generation. Defaults to `true`.
 
 `sidebar.filteredIds`
 
-Ids of pages to be filtered from the sidebar. This would typically be used to filter README or modules named index from the sidebar.
+Ids of pages to be filtered from the sidebar. This would typically be used to filter README or index pages from the sidebar.
 
 `sidebar.pretty`
 
-Pretty format the sidebar json
-
-#### `--docsRoot`
-
-The Docusaurus docs folder root. Use `./` if no root folder specified. Defaults to `./docs`.
-
-```shell
---docsRoot <path/to/docs-dir/>
-```
+Pretty format the sidebar JSON.
 
 ## Sidebar
 

package/dist/models.d.ts

@@ -1,12 +1,10 @@
 import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
 export interface PluginOptions extends TypedocPluginMarkdownOptions {
     id: string;
-    docsRoot: string;
     sidebar: Partial<SidebarOptions>;
 }
 export interface SidebarOptions {
     autoConfiguration: boolean;
-    readmeLabel: string;
-    indexLabel: string;
-    categoryLabel: string;
+    pretty: boolean;
+    filteredIds: string[];
 }

package/dist/options.js

@@ -3,14 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setOptions = exports.getPluginOptions = void 0;
 const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
-    docsRoot: 'docs',
-    out: 'api',
+    out: './docs/api',
     hideInPageTOC: true,
     hideBreadcrumbs: true,
     hidePageHeader: true,
     entryFileName: 'index.md',
     sidebar: {
         autoConfiguration: true,
+        pretty: false,
+        filteredIds: [],
     },
     plugin: ['typedoc-plugin-markdown'],
 };

package/dist/plugin.js

@@ -63,24 +63,31 @@ exports.default = pluginDocusaurus;
 async function generateTypedoc(context, opts) {
     const { siteDir } = context;
     const options = (0, options_1.getPluginOptions)(opts);
-    const { id, docsRoot, sidebar, ...optionsPassedToTypeDoc } = options;
-    const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
+    const { id, sidebar, ...optionsPassedToTypeDoc } = options;
+    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    const outputDir = app.options.getValue('out');
     if (options.cleanOutputDir) {
         removeDir(outputDir);
     }
-    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
     app.renderer.on(typedoc_1.PageEvent.END, (event) => {
         var _a;
         event.contents = (_a = event.contents) === null || _a === void 0 ? void 0 : _a.replace(/\\</g, '<');
     });
-    app.renderer.postRenderAsyncJobs.push(async (output) => {
-        const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
-        const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, options.out);
-        fs.writeFileSync(sidebarPath, `// @ts-check
+    if (sidebar === null || sidebar === void 0 ? void 0 : sidebar.autoConfiguration) {
+        app.renderer.postRenderAsyncJobs.push(async (output) => {
+            const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
+            const baseDir = path
+                .relative(siteDir, outputDir)
+                .split('/')
+                .slice(1)
+                .join('/');
+            const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, sidebar.filteredIds);
+            fs.writeFileSync(sidebarPath, `// @ts-check
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const typedocSidebar = { items: ${JSON.stringify(sidebarJson)}};
+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) {

package/dist/sidebar.d.ts

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

package/dist/sidebar.js

@@ -1,15 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSidebar = void 0;
-function getSidebar(navigation, basePath) {
+function getSidebar(navigation, basePath, filteredIds = []) {
     return navigation
-        .map((navigationItem) => {
-        return getNavigationItem(navigationItem, basePath);
-    })
+        .map((navigationItem) => getNavigationItem(navigationItem, basePath, filteredIds))
         .filter((navItem) => Boolean(navItem));
 }
 exports.getSidebar = getSidebar;
-function getNavigationItem(navigationItem, basePath) {
+function getNavigationItem(navigationItem, basePath, filteredIds) {
     var _a;
     const id = navigationItem.url
         ? `${basePath}/${navigationItem.url}`.replace(/(.*).md/, '$1')
@@ -18,11 +16,11 @@ function getNavigationItem(navigationItem, basePath) {
         return {
             type: 'category',
             label: navigationItem.title,
-            items: getSidebar(navigationItem.children, basePath),
+            items: getSidebar(navigationItem.children, basePath, filteredIds),
             ...(id && { link: { type: 'doc', id } }),
         };
     }
-    return id
+    return id && !filteredIds.includes(id)
         ? {
             type: 'doc',
             id,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.16",
+  "version": "1.0.0-next.17",
   "description": "A Docusaurus v2 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.21"
+    "typedoc-plugin-markdown": ">=4.0.0-next.22"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",