docusaurus-plugin-typedoc 1.0.0-next.10 → 1.0.0-next.12

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`
 
@@ -143,11 +146,6 @@ module.exports = {
 
         // Plugin options
         out: 'api-xyz',
-        sidebar: {
-          categoryLabel: 'API XYZ',
-          position: 0,
-          fullNames: true,
-        },
       },
     ],
   ],

package/dist/index.d.ts

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

package/dist/index.js

@@ -25,8 +25,11 @@ 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_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 {
@@ -44,6 +47,7 @@ function pluginDocusaurus(context, opts) {
                 .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]);
                     }
@@ -53,6 +57,9 @@ function pluginDocusaurus(context, opts) {
     };
 }
 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);
@@ -61,8 +68,11 @@ async function generateTypedoc(context, opts) {
     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;
@@ -70,7 +80,7 @@ async function generateTypedoc(context, opts) {
         console.error('[docusaurus-plugin-typedoc] TypeDoc exited with an error. Use the "skipErrorChecking" option to disable TypeDoc error checking.');
         process.exit();
     }
-    if (options.watch) {
+    if (app.options.getValue('watch')) {
         app.convertAndWatch(async (project) => {
             await app.generateDocs(project, outputDir);
         });

package/dist/models.d.ts

@@ -1,23 +1,11 @@
-import { TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
-export interface PluginOptions extends TypedocPluginMarkdownOptions {
+export interface PluginOptions {
     id: string;
     docsRoot: string;
     sidebar: SidebarOptions;
 }
 export interface SidebarOptions {
-    categoryLabel: string;
-    position: number | null;
     autoConfiguration: boolean;
+    readmeLabel: string;
+    indexLabel: string;
+    categoryLabel: string;
 }
-export interface SidebarCategory {
-    type: string;
-    label: string;
-    items: SidebarItem[];
-}
-export interface CategoryYamlOptions {
-    path: string;
-    label: string;
-    position: number | null;
-    collapsed: boolean;
-}
-export type SidebarItem = SidebarCategory | string;

package/dist/options.d.ts

@@ -1,4 +1,3 @@
 import { Application } from 'typedoc';
-import { PluginOptions } from './models';
-export declare function getPluginOptions(opts: Partial<PluginOptions>): PluginOptions;
+export declare function getPluginOptions(opts: Record<string, any>): Record<string, any>;
 export declare function loadOptions(app: Application): void;

package/dist/options.js

@@ -6,17 +6,13 @@ const DEFAULT_PLUGIN_OPTIONS = {
     id: 'default',
     docsRoot: 'docs',
     out: 'api',
-    watch: false,
-    plugin: [],
     hideInPageTOC: true,
     hideBreadcrumbs: true,
     hidePageHeader: true,
+    githubPages: false,
     includeFileNumberPrefixes: true,
-    skipIndexPage: true,
     entryFileName: 'index.md',
     sidebar: {
-        categoryLabel: 'API',
-        position: null,
         autoConfiguration: true,
     },
 };
@@ -48,12 +44,10 @@ function loadOptions(app) {
         }
         read(container) {
             const plugins = container.getValue('plugin');
-            ['typedoc-plugin-markdown', 'typedoc-plugin-frontmatter'].forEach((defaultPlugin) => {
-                if (!plugins.includes(defaultPlugin)) {
-                    plugins.push(defaultPlugin);
-                }
-            });
-            container.setValue('plugin', plugins);
+            container.setValue('plugin', plugins === null || plugins === void 0 ? void 0 : plugins.filter((plugin) => ![
+                'typedoc-plugin-markdown',
+                'typedoc-plugin-frontmatter',
+            ].includes(plugin)));
         }
     })());
 }

package/dist/renderer.js

@@ -16,52 +16,52 @@ function loadRenderer(app) {
 exports.loadRenderer = loadRenderer;
 function loadFrontmatter(app, event) {
     var _a, _b, _c, _d, _e, _f, _g;
-    const renderContext = app.renderer.theme.getRenderContext();
+    const hasReadme = !app.options.getValue('readme').endsWith('none');
+    const entryPage = app.options.getValue('entryFileName');
+    const indexPage = app.options.getValue('indexFileName');
     const sidebar = app.options.getValue('sidebar');
-    const isIndexPage = (_a = event.page) === null || _a === void 0 ? void 0 : _a.url.endsWith(renderContext.indexFileName);
-    const isReadmePage = (_b = event.page) === null || _b === void 0 ? void 0 : _b.url.endsWith(app.options.getValue('entryFileName'));
-    const isPackageModule = event.page.model.kindOf(typedoc_1.ReflectionKind.Module) &&
-        !Boolean(((_c = event.page.model) === null || _c === void 0 ? void 0 : _c.parent).groups);
-    const model = (_d = event.page) === null || _d === void 0 ? void 0 : _d.model;
+    const model = (_a = event.page) === null || _a === void 0 ? void 0 : _a.model;
+    const sidebarLabel = model === null || model === void 0 ? void 0 : model.name;
     let pluginFrontmatter = {};
     if (sidebar.autoConfiguration) {
-        if (!isIndexPage && !isReadmePage) {
-            const sidebarLabel = model === null || model === void 0 ? void 0 : model.name;
-            pluginFrontmatter = {
-                ...pluginFrontmatter,
-                sidebar_label: sidebarLabel,
-            };
-        }
-        if (((_e = event.page) === null || _e === void 0 ? void 0 : _e.url) === app.options.getValue('entryFileName')) {
+        if (((_b = event.page) === null || _b === void 0 ? void 0 : _b.url) === app.options.getValue('entryFileName')) {
             if (sidebar.categoryLabel) {
                 pluginFrontmatter = {
                     ...pluginFrontmatter,
                     sidebar_label: sidebar.categoryLabel,
                 };
             }
-            if (sidebar.position !== null && !Number.isNaN(sidebar.position)) {
+        }
+        if (hasReadme) {
+            if (((_c = event.page) === null || _c === void 0 ? void 0 : _c.url) === entryPage) {
                 pluginFrontmatter = {
                     ...pluginFrontmatter,
-                    sidebar_position: sidebar.position,
+                    ...(sidebar.readmeLabel && { sidebar_label: sidebar.readmeLabel }),
+                    sidebar_position: 0,
+                };
+            }
+            if (((_d = event.page) === null || _d === void 0 ? void 0 : _d.url) === `01-${indexPage}`) {
+                pluginFrontmatter = {
+                    ...pluginFrontmatter,
+                    ...(sidebar.indexLabel && { sidebar_label: sidebar.indexLabel }),
                 };
             }
         }
-        if ((_f = event.page) === null || _f === void 0 ? void 0 : _f.url.endsWith(app.options.getValue('entryFileName'))) {
-            pluginFrontmatter = {
-                ...pluginFrontmatter,
-                hide_table_of_contents: true,
-            };
-        }
-        if (isPackageModule && isReadmePage) {
-            pluginFrontmatter = {
-                ...pluginFrontmatter,
-                sidebar_label: event.page.model.name,
-            };
+        else {
+            if (((_e = event.page) === null || _e === void 0 ? void 0 : _e.url) === entryPage) {
+                pluginFrontmatter = {
+                    ...pluginFrontmatter,
+                    ...(sidebar.indexLabel && { sidebar_label: sidebar.indexLabel }),
+                    sidebar_position: 0,
+                };
+            }
         }
-        if (isPackageModule && isIndexPage && Boolean((_g = event.page.model) === null || _g === void 0 ? void 0 : _g.readme)) {
+        // Add sidebar labels to all pages
+        if (!(((_f = event.page) === null || _f === void 0 ? void 0 : _f.url) === entryPage) &&
+            !(((_g = event.page) === null || _g === void 0 ? void 0 : _g.url) === `01-${indexPage}`)) {
             pluginFrontmatter = {
                 ...pluginFrontmatter,
-                sidebar_label: 'Index',
+                sidebar_label: sidebarLabel,
             };
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.10",
+  "version": "1.0.0-next.12",
   "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
@@ -16,17 +16,16 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "dependencies": {
-    "typedoc-plugin-frontmatter": "^0.0.2"
+    "typedoc-plugin-frontmatter": ">=0.0.2"
   },
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.12"
+    "typedoc-plugin-markdown": ">=4.0.0-next.13"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "npm run lint && npm run build && npm run test",
+    "prepublishOnly": "npm run lint && npm run build",
     "build": "rm -rf ./dist && tsc",
-    "build-and-test": "npm run build && npm run test",
-    "test": "jest --colors"
+    "build-and-test": "npm run build && npm run test"
   },
   "author": "Thomas Grey",
   "license": "MIT",